PATCH: doc typos

The attached patch fixes some typos in the
documentation of the configuration options.
-- Boaz

__________________________________
Do you Yahoo!?
Exclusive Video Premiere - Britney Spears
http://launch.yahoo.com/promos/britneyspears/

Index: src/config.l
===================================================================
RCS file: /u/kp3softd/cvsroot/src/config.l,v
retrieving revision 1.115
diff -u -r1.115 config.l
--- src/config.l	19 Oct 2003 20:01:59 -0000	1.115
+++ src/config.l	27 Oct 2003 18:52:35 -0000
 <at>  <at>  -1489,7 +1489,7  <at>  <at> 
                     "will interpret the first line (until the first dot) of a JavaDoc-style \n"
                     "comment as the brief description. If set to NO, the JavaDoc \n"
                     "comments will behave just like the Qt-style comments (thus requiring an \n"
-                    "explict  <at> brief command for a brief description. \n",
+                    "explicit  <at> brief command for a brief description. \n",
                     FALSE
                  );
   cb = addBool(
 <at>  <at>  -1513,7 +1513,7  <at>  <at> 
                     "INHERIT_DOCS",
                     "If the INHERIT_DOCS tag is set to YES (the default) then an undocumented \n"
                     "member inherits the documentation from any documented member that it \n"
-                    "reimplements. \n",

PATCH: date/time format

Currently, date/time strings in the generated 
documentation are based on local-time, and appear
in a fixed (hard-coded), English-based format.
I'd like to have better control on the format,
and optionally use UTC time.
The attached patch introduces three new 
configuration options:
  DATETIME_FORMAT strftime(3) format for date/time
  DATE_FORMAT     strftime(3) format for date
  UTC_DATETIME    if YES, use UTC time; else use local time

The default values for these options preserve the
current behavior (but see caveat below).

Caveat: The resulting date/time strings might be 
        locale-dependent. To correctly emulate the
        current behavior, one must set the environment
        to use the default (C) locale before running doxygen.

Portability note: The new code should work on all Unix-like
systems, as well as Windows (at least with MS Visual C++).
The existing code uses Qt code that seems to also support 
OS/2 and DOS, which the new code, most likely, does _not_
support. I wasn't sure if doxygen itself is expected to support
these platforms; to be on the safe side, the new code is 
conditioned on not being executed in any of these platforms,
so if doxygen used to work there, it should still work, only
without these new options. If these platforms are not really
supported, some #ifdef's and #ifdef'ed code (all marked with
FIXME comments) can be safely removed.

PATCH: class-list order

Consider this scenario:

/// Proj
namespace PROJ {
    /// Foo
    namespace FOO {
        /// Class %A
        class A {};
        /// Class %C
        class C {};
    }
    /// Bar
    namespace BAR {
        /// Class %B
        class B {};
        /// Class %D
        class D {};
    }
}

Currently, classes in the Class List are sorted by 
class name, ignoring namespaces:

  PROJ::FOO::A
  PROJ::BAR::B
  PROJ::FOO::C
  PROJ::BAR::D

I'd like classes (compounds) to be sorted by 
fully qualified scoped names:

Simple <at> todo improvements?

Hi,

(I'm new to Doxygen, so I apologize if the things below are 
a matter of config settings. At the moment it seems they aren't.)

------------

 <at> todo items appear not to be collected globally (or on a
file level), irrespective of being in a special comment or 
not. Only those get listed that are in comments related
to classes, methods etc.

Is this true, or am I just missing something?

If so, this would be nice to amend, as many todo items are 
pretty generic things, very frequently not associated with 
any already existing language constructs, but are feature/
improvement/correction suggestions and ideas etc. on a 
project-global or a module/file level.

In my practice, the "global" todo stuff is actually far 
more important than the "fixme"-like comments relevant to 
certain code constructs (classes etc.). So, given that 
Doxygen already supports the latter very nicely, it would 
be quite natural to do same for the global ones, too.

(The Related Pages --> Todo List is already straightforward 
place for listing the project-global  <at> todo items, as is the 
File List for the file-global todo item collections.)

Windows binaries available for Doxygen-1.3.4-20031103

(Sorry for the delay -- problems with compilation.)

Hi,

If interested, you can download the doxygen binaries
compiled for MS Windows from

  http://doxygen.sourceforge.net/dl/doxygen-1.3-cvs/

This is the place where you should find also the next
releases.  The name of the archive is constructed 
from the date of CVS release.

The binaries are NOT created automatically, so it may
happen that some newer CVS sources were not compiled
because I am not present to do that or I forgot... ;)

Regards,
  Petr

--

-- 
Petr Prikryl (prikrylp at skil dot cz)

-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?   SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/

Language & XML

	Hi, Dimitri & language maintainers.
	There is some problem with language dependencies XML format. Language dependencies charecters coded as 
	&#x**; 
but notation &#x****; reserved for UNICODE charecters. There are two solutions (I don't know, what is the
best FOR OTHER THAN RUSSIAN LANGUAGE)
	1. (I think it is best way for me) Don't code charecters that <128 as &#x** (simple remove code 
        if (c<0) 
        {
	    result+=(QCString)"&#x" + 
                  nibbleToHex((((uchar)c)>>4)&0xf)+
                  nibbleToHex(c&0xf)+";";
        }
        else 
        {

at function convertToXML)

	2. Translate chars <128 to unicode with help of Translator function:
virtual Q_UINT16 toUnicode( char c );
	to translator*.*

	and modify convertToXML as 
        if (c<0) 
        {
		char str[10];
		sprintf( str, "&#x%X;", theTranslator->toUnicode( c ) );
		result += str;
        }
	  else
	  {

Localization problems

	Hi, Dimitri.
	On Windows isupper define is not work correctly (crash on Debug, invalid results on Release).
	Incorrect: isupper(c)
	Correct: QChar(c).category()==QChar::Letter_Uppercase

Index: src/definition.cpp
===================================================================
RCS file: /u/kp3softd/cvsroot/src/definition.cpp,v
retrieving revision 1.71
diff -u -r1.71 definition.cpp
--- src/definition.cpp	5 Oct 2003 12:34:04 -0000	1.71
+++ src/definition.cpp	8 Nov 2003 13:40:39 -0000
 <at>  <at>  -219,7 +219,7  <at>  <at> 
     {
       case '.': case '!': case '?': break;
       default: 
-        if (isupper(m_brief.at(0))) m_brief+='.'; 
+        if (QChar(m_brief.at(0)).category()==QChar::Letter_Uppercase) m_brief+='.';
         break;
     }
   }

-------------------------------------------------------
This SF.Net email sponsored by: ApacheCon 2003,
16-19 November in Las Vegas. Learn firsthand the latest
developments in Apache, PHP, Perl, XML, Java, MySQL,
WebDAV, and more! http://www.apachecon.com/

Windows binaries available for Doxygen-1.3.4-20031112

Hi,

If interested, you can download the doxygen binaries
compiled for MS Windows from

  http://doxygen.sourceforge.net/dl/doxygen-1.3-cvs/

This is the place where you should find also the next
releases.  The name of the archive is constructed 
from the date of CVS release.

The binaries are NOT created automatically, so it may
happen that some newer CVS sources were not compiled
because I am not present to do that or I forgot... ;)

Regards,
  Petr

--

-- 
Petr Prikryl (prikrylp at skil dot cz)

-------------------------------------------------------
This SF.Net email sponsored by: ApacheCon 2003,
16-19 November in Las Vegas. Learn firsthand the latest
developments in Apache, PHP, Perl, XML, Java, MySQL,
WebDAV, and more! http://www.apachecon.com/

FW: Missing file in source distribution

I downloaded doxygen-1.3.4.src.tar.gz
from http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
but it seems to be missing packagedefs.cpp

So, I can not compile.

Help would be appreciated.

Thanks,

jeffw

-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?  SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/

how to hide/ignore function like maro end with ";"

Hello,

All my source code includes the following macro after include block.
INIT_DIAG();
INIT_DEBUG();

and optionally macro like before.

INIT_CRITICAL_REGION (data_crit);

These macros are more like SKIP_FUNCTION_MACROS (function-like macros 
that are alone on a line), however they end with ";". Because of this I 
presume they are shown as functions.

Is there a  way I can stop this macros been generated as functions.

Thanks

Jeeva.

-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?  SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/