doxygen-develop — List for discussing new features, submitting patches, etc.

[Doxygen-develop] PATCH: sorting brief descriptions, text only standard footer

[Akos K. <ak...@us...>]

Hi all,

I started recently to use doxygen, since I was in need to document my 
projects. Unfortunately, there were some features I missed, so attached is a 
patch to add some of them. I hope you will find it useful an worthy to 
include it into the CVS.

The current patch adds two features.

1) Sorting brief descriptions
I find sorting brief descriptions by member name more useful than sorting 
detailed descriptions, since the reader of the documentation faces those 
first. I've added a new configuration option SORT_BRIEF_DOCS to allow the 
sorting of brief descriptions.

2) Text only standard footer
All the generated HTML files are text only except for the doxygen logo, so why 
including a graphic element at all? Additionally, the color scheme of the 
default stylesheet is very nice, but the colors of the logo do not fit in. So 
I've added HTML_SHOW_LOGO to control the behaviour of the standard footer.

I don't know whether you require GNU-style ChangeLog entries so you can find 
them at the end of the e-mail.

Regards,
Akos

2003-12-12  Akos Kiss  <ak...@us...>

        * src/config.l (SORT_BRIEF_DOCS): New configuration option.
        * doc/config.doc (SORT_BRIEF_DOCS): Document it.
        * src/classdef.cpp (ClassDef::internalInsertMember): Use it.
        * src/namespacedef.cpp (NamespaceDef::insertClass,
        NamespaceDef::insertMember): Likewise.
        * src/filedef.cpp (FileDef::insertMember, FileDef::insertClass,
        FileDef::insertNamespace): Likewise.
        * src/groupdef.cpp (GroupDef::addFile, GroupDef::addClass,
        GroupDef::addNamespace, GroupDef::insertMember): Likewise.

        * src/config.l (HTML_SHOW_LOGO): New configuration option.
        * doc/config.doc (HTML_SHOW_LOGO): Document it.
        * src/htmlgen.cpp (HtmlGenerator::init, writePageFooter): Use it.

[Doxygen-develop] CALL_GRAPH is missing function

[Stefan K. <ko...@im...>]

hi dimitri,

for the following code the callgraph is missing the gitk_init() function, but
has two arows pointing to gitk-done(). The graph is attached.

int test_gitk_init(void {
  gitk_init(&test_argc,&test_argvptr,PACKAGE,LOCALEDIR);
  gitk_done();
}


If have used the following statements in Doxyfile :

PREDEFINED             = "LOCALEDIR=\"/usr/share/locale\""
EXCLUDE_PATTERNS       = config.h

1.) How can I verify that the parser not stumbles upon something like
gitk_init(&test_argc,&test_argvptr,,);
due to uninitialized macros. Is the above definition for PREDEFINED correct when
I want LOCALEDIR to resolve to "/usr/share/locale"?

2.) When I ask that "config.h" should be excluded from the documentation, will
doxygen still read the file when it hits an include statement, so that the
defines from that file are expanded?

Ciao
  Stefan
-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

[Doxygen-develop] type in Doxyfile

[Stefan K. <ko...@im...>]

in doxyfile a letter is missing (the 'i' in the word 'additions' after 'add')

old
#---------------------------------------------------------------------------
# Configuration::addtions related to external references
#---------------------------------------------------------------------------

new
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------

cu
  Stefan
-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

[Doxygen-develop] PATCH: doxygen.org link in footer

[Stefan K. <ko...@im...>]

hi Dimitri,

in the html footer there where spaces in the <a href=""></a> tag an the enclose
<img> tag, thus a blue underlined blank appeared next to the image.
The enclosed patch (diff -u) fixes this and furthermore make the two methods
which output the html footer more comparable.
I hope you will apply this little patch.

Ciao
  Stefan
-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

[Doxygen-develop] consistent style of docs

[Stefan K. <ko...@im...>]

hi dimitri,

1.) style of lists :

in the alphabetical list :
  headings for each letter are white with black background
  letters in the headings and quicknav-bar are all uppercase
  items have no bullet

in the data-fileds and globals list
  headings for each letter are black on white background and delimmited by '-'
  letters in the headings and quicknav-bar are all lowercase
  all items have a bullet

can this be changed so that it is uniformous. I prefer the style of the
alphabetical list.

2.) Can you rename the 'Alphabetical List to 'Compounds' so that it appears
as 'Compounds' in the header and as '<projectname> Compounds' in the heading of
the list page.

3.) Can we extend @defgroup so that it can have a brief description, which will
be shown on the modules.html page (or the modules section of modules).
Can the Modules list look like in the Modules sections of submodules?

/** @defgroup gitkcore libgitk core
 * @brief The gitk core module
 * The gitk core module. Manages plugin handling and provides common support
routines.<br>
 * Client applications of this library should start using the library by calling
gitk_init(...)
 */

-----------

Finaly I don't want to load this all onto your shoulders. If would see if I can
implement it and send a patch. I just would like to know before, if the ideas
would be accepted. So please answer ...

Ciao
  Stefan
-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

[Doxygen-develop] search produces dead links

[Stefan K. <ko...@im...>]

hi dimitri, its me again

the search produces links to e.g.
http://<server>/<path>/namespace_3globalScope_4.html

where the respective files do not exists (beginning with "namespace").
The documented project is a pure 'C' thus defining no namespaces.

Ciao
  Stefan
-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

[Doxygen-develop] Member XXX of <file> is not documented

[Stefan K. <ko...@im...>]

hi all,

sometimes doxygen is warning that  :

Member GITK_RENDERER_C of file gitk-renderer-text/gitkrlayout.c is not documented.

the file starts as below

/** $Id: gitkrlayout.c,v 1.21 2003/11/25 16:11:20 ensonic Exp $
 *
 * @file   gitk-renderer-text/gitkrlayout.c
 * @author Stefan Kost <ko...@im...>
 * @date   Fri Jan 25 09:48:16 2002
 *
 * @brief  gitk renderer layout routines
 * @ingroup gitkrenderertext
 *
 */

#define GITK_RENDERER_C
#define GITKR_LAYOUT_C

other files start like this as well, but I don't get such warnings for them.

Ciao
  Stefan
-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

Re: [Doxygen-develop] doxygen preprocessor, not always expands

[Stefan K. <ko...@im...>]

Hi Sigmund,

many thanks, that works. I hope that Dimitri will apply the patch.

Ciao
 Stefan

Sigmund Augdal wrote:
>>was the patch denied or ignored. Maybe should should you should bug dimitri to
>>pay attantion to it again. Unfortunately I get thousands of diffenrences when
>>comparing doxygen 1.3.5 (to which I just have upgraded). So I am not sure, what
>>and how much you actually have changed.
> 
> The patch was ignored if I recall correct. The version I linked to was a
> patched version about 1.3.1, so there should be many changes compared to
> 1.3.5. Therefor I resend the patch adapted to 1.3.5. Hope it suits your
> needs, and hope it will be accepted in some form.
> 
> Sigmund

-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

Re: [Doxygen-develop] doxygen preprocessor, not always expands

[Stefan K. <ko...@im...>]

Hi Dimitri,

I've had a deeper look into it.

> === Problem 1:
> when running doxygen it expands the macro there, but complains about
> undocumented variables. Are the documentes inside the define dropped?
> 
> header1.h:6:Warning: Member id of class GitkWidget is not documented.
> header1.h:6:Warning: Member context of class GitkWidget is not documented.
> header1.h:6:Warning: Member type of class GitkWidget is not documented.
> 
As I've already found out it wish-item 49:
And it look to me that in 'src/pre.l' the following line need to be changed :
<SkipLine,SkipCommand,SkipCPPBlock>"//"	{
  					  g_lastCPPContext=YY_START;
  					  BEGIN(RemoveCPPComment);
					}
<SkipLine,SkipCommand,SkipCPPBlock>"/*"	{
					  g_lastCContext=YY_START;
  					  BEGIN(RemoveCComment);
  					}

so that doxygen-comments (/**) are not removed, e.g like below (this might not
work as I just have started to read about lex and co - I've never used them before).

<SkipLine,SkipCommand,SkipCPPBlock>"/*"{
					  g_lastCContext=YY_START;
  					  BEGIN(CComment);
  					}
<CComment>"*"				{
					  BEGIN{CopyCComment};
					}
<CComment>[^*]				{
  					  BEGIN(RemoveCComment);
					}

I would be really happy if this could be fixed soon, as I have a deadline at the
end of this year :-(.

Ciao
  Stefan

> === Problem 2:
> it does not expand the define in the second header file. Both, the data-fields
> list and the graph are missing the 'inherited' elements.
> 
> header2.h:3:Warning: Member GitkWidgetFields of class GitkrGtkWidget is not
> documented.
> 
> ===
> 
> Anyway, does anyone has a better idea, of how to do 'inheritance' in C (not
> C++). Unfortunately I am bound to use gcc 2.95 and this one does not support
> anonymous structs/unions.
> Wouldn't it be a good idea to have a @extends command (which should not be used
> in C++/Java) so that I call documents such relations even in C.
> 
> Ciao
>   Stefan

-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

[Doxygen-develop] generated Test and Todo page for Java

[Martin F. <mar...@gm...>]

Hello,

seems there is a little bug in Doxygen when generating the Test and Todo pa=
ges with activated OPTIMIZE_OUTPUT_JAVA option: The package names are print=
ied in C++ notation "xxx::yyy::zzz" instead of java notation "xxx.yyy.zzz".

I am using Doxygen 1.3.4.

-- 
Martin Fuchs
mar...@gm...

Re: [Doxygen-develop] doxygen preprocessor, not always expands

[Stefan K. <ko...@im...>]

Hi again,


> === Problem 1:
> when running doxygen it expands the macro there, but complains about
> undocumented variables. Are the documentes inside the define dropped?
> 
> header1.h:6:Warning: Member id of class GitkWidget is not documented.
> header1.h:6:Warning: Member context of class GitkWidget is not documented.
> header1.h:6:Warning: Member type of class GitkWidget is not documented.
> 
I've found it to be number 49 on Doxygens todo/wishlist.
seems to happens somewhere in 'src/pre.cpp' although after a first look at the
source I don't dare to change anything there.
Dimitri: any chance that you can resolve this for the next version?

> === Problem 2:
> it does not expand the define in the second header file. Both, the data-fields
> list and the graph are missing the 'inherited' elements.
> 
> header2.h:3:Warning: Member GitkWidgetFields of class GitkrGtkWidget is not
> documented.
> 
> ===
> 
> Anyway, does anyone has a better idea, of how to do 'inheritance' in C (not
> C++). Unfortunately I am bound to use gcc 2.95 and this one does not support
> anonymous structs/unions.
> Wouldn't it be a good idea to have a @extends command (which should not be used
> in C++/Java) so that I call documents such relations even in C.
> 
> Ciao
>   Stefan

-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

Re: [Doxygen-develop] doxygen preprocessor, not always expands

[Stefan K. <ko...@im...>]

Hi Sigmund,

was the patch denied or ignored. Maybe should should you should bug dimitri to
pay attantion to it again. Unfortunately I get thousands of diffenrences when
comparing doxygen 1.3.5 (to which I just have upgraded). So I am not sure, what
and how much you actually have changed.

Dimitri: are you aware of the problem? Can you please comment on it.

Ciao
  Stefan

> I sent a patch to fix this kind of problem a while ago, but it never got
> accepted. If you want you can try my patched version at
> ftp://ftp.videolan.org/pub/videolan/devtools/doxygen-vlcpatched.tgz
> (it is getting a bit old now)
> I hope a future version of doxygen whould include such a fix, since I don't
> feel like maintaining a paralell tree.
> 
> Sigmund Augdal
> 
> 
> On Mon, Dec 08, 2003 at 01:36:30PM +0100, Stefan Kost wrote:
> 
>>hi dimitri and others,
>>
>>I am using Doxygen version 1.3.3.
>>In the documentation of a C based project I have the following situation :
>>
>>=== header1.h
>>
>>struct GitkWidget {
>>#define GitkWidgetFields \
>>  gchar *id; /**< @brief string identification */\
>>  GitkContextPtr context; /**< @brief context the widget belongs to */\
>>  GitkWidgetType type /**< @brief what kind of widget is it */
>>  GitkWidgetFields;
>>};
>>
>>=== header2.h
>>
>>#include "header1.h"
>>struct GitkrGtkWidget {
>>  GitkWidgetFields;
>>  GtkWidget *impl; /**< @brief the widget implementation */
>>};
>>
>>=== Doxyfile
>>
>>ENABLE_PREPROCESSING   = YES
>>MACRO_EXPANSION        = YES
>>EXPAND_ONLY_PREDEF     = NO
>>SEARCH_INCLUDES        = YES
>>SKIP_FUNCTION_MACROS   = YES
>>
>>===
>>
>>=== Problem 1:
>>when running doxygen it expands the macro there, but complains about
>>undocumented variables. Are the documentes inside the define dropped?
>>
>>header1.h:6:Warning: Member id of class GitkWidget is not documented.
>>header1.h:6:Warning: Member context of class GitkWidget is not documented.
>>header1.h:6:Warning: Member type of class GitkWidget is not documented.
>>
>>=== Problem 2:
>>it does not expand the define in the second header file. Both, the data-fields
>>list and the graph are missing the 'inherited' elements.
>>
>>header2.h:3:Warning: Member GitkWidgetFields of class GitkrGtkWidget is not
>>documented.
>>
>>===
>>
>>Anyway, does anyone has a better idea, of how to do 'inheritance' in C (not
>>C++). Unfortunately I am bound to use gcc 2.95 and this one does not support
>>anonymous structs/unions.
>>Wouldn't it be a good idea to have a @extends command (which should not be used
>>in C++/Java) so that I call documents such relations even in C.
>>
>>Ciao
>>  Stefan
>>-- 
>>      \|/            Stefan Kost
>>     <@ @>           private            business
>>+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
>>|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
>>|      ///           04277 Leipzig      04251 Leipzig
>>| __  ///            Germany            Germany
>>| \\\///    Phone    +49341 2253538     +49341 30766101
>>|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
>>|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
>>===-=-=--=---=---------------------------------- - - -  -    -
>>
>>
>>
>>-------------------------------------------------------
>>This SF.net email is sponsored by: IBM Linux Tutorials.
>>Become an expert in LINUX or just sharpen your skills.  Sign up for IBM's
>>Free Linux Tutorials.  Learn everything from the bash shell to sys admin.
>>Click now! http://ads.osdn.com/?ad_id=1278&alloc_id=3371&op=click
>>_______________________________________________
>>Doxygen-develop mailing list
>>Dox...@li...
>>https://lists.sourceforge.net/lists/listinfo/doxygen-develop
> 
> 

-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

[Doxygen-develop] doxygen preprocessor, not always expands

[Stefan K. <ko...@im...>]

hi dimitri and others,

I am using Doxygen version 1.3.3.
In the documentation of a C based project I have the following situation :

=== header1.h

struct GitkWidget {
#define GitkWidgetFields \
  gchar *id; /**< @brief string identification */\
  GitkContextPtr context; /**< @brief context the widget belongs to */\
  GitkWidgetType type /**< @brief what kind of widget is it */
  GitkWidgetFields;
};

=== header2.h

#include "header1.h"
struct GitkrGtkWidget {
  GitkWidgetFields;
  GtkWidget *impl; /**< @brief the widget implementation */
};

=== Doxyfile

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = NO
SEARCH_INCLUDES        = YES
SKIP_FUNCTION_MACROS   = YES

===

=== Problem 1:
when running doxygen it expands the macro there, but complains about
undocumented variables. Are the documentes inside the define dropped?

header1.h:6:Warning: Member id of class GitkWidget is not documented.
header1.h:6:Warning: Member context of class GitkWidget is not documented.
header1.h:6:Warning: Member type of class GitkWidget is not documented.

=== Problem 2:
it does not expand the define in the second header file. Both, the data-fields
list and the graph are missing the 'inherited' elements.

header2.h:3:Warning: Member GitkWidgetFields of class GitkrGtkWidget is not
documented.

===

Anyway, does anyone has a better idea, of how to do 'inheritance' in C (not
C++). Unfortunately I am bound to use gcc 2.95 and this one does not support
anonymous structs/unions.
Wouldn't it be a good idea to have a @extends command (which should not be used
in C++/Java) so that I call documents such relations even in C.

Ciao
  Stefan
-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

[Doxygen-develop] enhancement request wrt commenting convention

[Andrew M. <ap...@st...>]

I have a doxygen enhancement request.  Normally, the request would not be
necessary because either the developer concerned (not me, BTW) would do one
of two things:

1) conform to the doxygen commenting conventions
2) write a pre-filter

but this developer will not do either and hell will freeze over before
he changes his opinion on /anything/.  So we are stuck with millions
of headers that have the comments AFTER the member variable/function.
Can a switch be added to the doxygen config file to cope with this?

I don't like doxygen having to change just because someone refuses to
conform to its simple well established commenting conventions.  So
feel free to say 'no'. But it would help me out of a deep dark hole.

Regards,

Andrew Marlow

Re: [Doxygen-develop] how to document files other than c,c++,java ?

[Dimitri v. H. <di...@st...>]

On Thu, Nov 27, 2003 at 05:11:28PM +0100, Stefan Kost wrote:
> hi again,
> 
> here is an extendet version of the script.
> 
> dimitri: can we define new structural commands like \fn \file \def ...
> when I document a dtd I would like to have \entity \element and \attlist
> 
> so what I am asking for is something like
> 
> \defstructcmd <structcmd> <singular> <plural>
> \defstructcmd entity Entity Entities
> 
> /** \structcmd entity <entity-name>
>   * \brief ....
>   */

This is not possible now, but for the things you want to do it is a nice
feature to have. Maybe you can help me implement it.

Regards,
  Dimitri

[Doxygen-develop] Inner group generation problem

[<ca...@cr...>]

	Hi.
	At xml output format inner group's references (refid) are same as=20
owner group. Please, apply patch.

Index: src/xmlgen.cpp
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /u/kp3softd/cvsroot/src/xmlgen.cpp,v
retrieving revision 1.60
diff -u -r1.60 xmlgen.cpp
--- src/xmlgen.cpp	3 Nov 2003 18:04:43 -0000	1.60
+++ src/xmlgen.cpp	27 Nov 2003 17:45:14 -0000
@@ -1377,7 +1377,7 @@
     GroupDef *sgd;
     for (gli.toFirst();(sgd=3Dgli.current());++gli)
     {
-      t << "    <innergroup refid=3D\"" << gd->getOutputFileBase()
+      t << "    <innergroup refid=3D\"" << sgd->getOutputFileBase()
         << "\">" << convertToXML(sgd->groupTitle())=20
         << "</innergroup>" << endl;
     }

Re: [Doxygen-develop] how to document files other than c,c++,java ?

[Stefan K. <ko...@im...>]

hi again,

here is an extendet version of the script.

dimitri: can we define new structural commands like \fn \file \def ...
when I document a dtd I would like to have \entity \element and \attlist

so what I am asking for is something like

\defstructcmd <structcmd> <singular> <plural>
\defstructcmd entity Entity Entities

/** \structcmd entity <entity-name>
  * \brief ....
  */

Ciao
  Stefan


> hi again,
> 
> should have read some more before asking. Attached is version 0.1 of such a
> filter script (perl). At least file comments do work. More to come tommorow
> 
> Ciao
>  Stefan
> 
> Stefan Kost wrote:
> 
>>hi hi,
>>
>>has anyone achived to document files other that c,c++,java?
>>my system includes xml, xsl files and a dtd. For completness I would at least
>>document the files themselfs. So I tried things like
>><!--
>>  @file test.dtd
>>  @brief the test document type definition
>>-->
>>
>>as well as
>>
>><!--
>>/**
>> * @file test.dtd
>> * @brief the test document type definition
>> */
>>-->
>>
>>The file appear in the section of files, but without the comment. When I follow
>>the [code] link the /** .. */ comment is not part of the source listing.
>>
>>Ciao
>>Stefan
> 
> 
> 
> ------------------------------------------------------------------------
> 
> #!/usr/local/bin/perl
> 
> if(!defined($ARGV[0])) { exit; }
> 
> #print "arg : ".$ARGV[0]."\n";
> $ifilename=$ARGV[0];
> 
> if($ifilename=~m/.*\.dtd/) { &filter_dtd($ifilename); }
> elsif($ifilename=~m/.*\.x[ms]l/) { &filter_xml($ifilename); }
> else { &filter_dummy($ifilename); }
> 
> exit;
> 
> sub filter_dtd {
> 	my ($fn)=@_;
> 
> 	if(open(FHI,"<$fn")) {
> 		while($line=<FHI>) {
> 			$line=~s/\<\!\-\-/\/\*\*/g;
> 			$line=~s/\-\-\>/\*\//g;
> 			print $line;
> 		}
> 		close(FHI);
> 	}
> }
> 
> sub filter_xml {
> 	my ($fn)=@_;
> 
> 	if(open(FHI,"<$fn")) {
> 		while($line=<FHI>) {
> 			$line=~s/\<\!\-\-/\/\*\*/g;
> 			$line=~s/\-\-\>/\*\//g;
> 			if(($line!~m/^\<\?xml/) && ($line!~m/^\<\!DOCTYPE/)) {
> 				print $line;
> 			}
> 		}
> 		close(FHI);
> 	}
> }
> 
> sub filter_dummy {
> 	my ($fn)=@_;
> 
> 	if(open(FHI,"<$fn")) {
> 		while($line=<FHI>) {
> 			print $line;
> 		}
> 		close(FHI);
> 	}
> }

-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

Re: [Doxygen-develop] how to document files other than c,c++,java ?

[Stefan K. <ko...@im...>]

hi again,

should have read some more before asking. Attached is version 0.1 of such a
filter script (perl). At least file comments do work. More to come tommorow

Ciao
 Stefan

Stefan Kost wrote:
> hi hi,
> 
> has anyone achived to document files other that c,c++,java?
> my system includes xml, xsl files and a dtd. For completness I would at least
> document the files themselfs. So I tried things like
> <!--
>   @file test.dtd
>   @brief the test document type definition
> -->
> 
> as well as
> 
> <!--
> /**
>  * @file test.dtd
>  * @brief the test document type definition
>  */
> -->
> 
> The file appear in the section of files, but without the comment. When I follow
> the [code] link the /** .. */ comment is not part of the source listing.
> 
> Ciao
> Stefan

-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

Re: [Doxygen-develop] how to document files other than c,c++,java ?

[Christian B. <chr...@am...>]

Allo Stefan!

Yes, try this.

Add the following:
  a.. /** @verbatim */ as the first line inside comment style of the =
file
  b.. /** @endverbatim */ as the last line inside comment style of the =
file
This should be done without any @file and @brief.

Create another file (filedescriptions.dox) and to write your file =
descriptions like so:
/**
 * @file test.dtd
 * @brief The test document type definition.
 * The long description of the file.
 */

/**
 * @file myothertest.dtd
 * @brief My other test document type definition.
 * The long description of the file.
 */

Include in the configuration INPUT parameter the test.dtd, =
myothertest.dtd and filedescriptions.dox.

I used this to document Perl script and had no problems.

Salut!

Christian

  ----- Original Message -----=20
  From: Stefan Kost=20
  To: dox...@li...=20
  Sent: Tuesday, November 25, 2003 12:30 PM
  Subject: [Doxygen-develop] how to document files other than c,c++,java =
?


  hi hi,

  has anyone achived to document files other that c,c++,java?
  my system includes xml, xsl files and a dtd. For completness I would =
at least
  document the files themselfs. So I tried things like
  <!--
    @file test.dtd
    @brief the test document type definition
  -->

  as well as

  <!--
  /**
   * @file test.dtd
   * @brief the test document type definition
   */
  -->

  The file appear in the section of files, but without the comment. When =
I follow
  the [code] link the /** .. */ comment is not part of the source =
listing.

  Ciao
  Stefan
  --=20
        \|/            Stefan Kost
       <@ @>           private            business
  +-oOO-(_)-OOo------------------------------------------------------ - =
- -  -   -
  |       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach =
301166
  |      ///           04277 Leipzig      04251 Leipzig
  | __  ///            Germany            Germany
  | \\\///    Phone    +49341 2253538     +49341 30766101
  |  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
  |           WWW      www.sonicpulse.de  =
www.imn.htwk-leipzig.de/~kost/about.html
  =3D=3D=3D-=3D-=3D--=3D---=3D---------------------------------- - - -  =
-    -



  -------------------------------------------------------
  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/
  _______________________________________________
  Doxygen-develop mailing list
  Dox...@li...
  https://lists.sourceforge.net/lists/listinfo/doxygen-develop

[Doxygen-develop] how to document files other than c,c++,java ?

[Stefan K. <ko...@im...>]

hi hi,

has anyone achived to document files other that c,c++,java?
my system includes xml, xsl files and a dtd. For completness I would at least
document the files themselfs. So I tried things like
<!--
  @file test.dtd
  @brief the test document type definition
-->

as well as

<!--
/**
 * @file test.dtd
 * @brief the test document type definition
 */
-->

The file appear in the section of files, but without the comment. When I follow
the [code] link the /** .. */ comment is not part of the source listing.

Ciao
Stefan
-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

[Doxygen-develop] how to hide/ignore function like maro end with ";"

[Jeeva S C. <gci...@ho...>]

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.

[Doxygen-develop] FW: Missing file in source distribution

[Jeff W. <jwe...@pa...>]

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

[Doxygen-develop] Windows binaries available for Doxygen-1.3.4-20031112

[Petr P. <Pr...@sk...>]

Hi,
=20
If interested, you can download the doxygen binaries
compiled for MS Windows from
=20
  http://doxygen.sourceforge.net/dl/doxygen-1.3-cvs/
=20
This is the place where you should find also the next
releases.  The name of the archive is constructed=20
from the date of CVS release.
=20
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... ;)
=20
Regards,
  Petr
=20
--=20
Petr Prikryl (prikrylp at skil dot cz)

[Doxygen-develop] Localization problems

[<ca...@cr...>]

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

Index: src/definition.cpp
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
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
@@ -219,7 +219,7 @@
     {
       case '.': case '!': case '?': break;
       default:=20
-        if (isupper(m_brief.at(0))) m_brief+=3D'.';=20
+        if =
(QChar(m_brief.at(0)).category()=3D=3DQChar::Letter_Uppercase) =
m_brief+=3D'.';
         break;
     }
   }

[Doxygen-develop] Language & XML

[<ca...@cr...>]

	Hi, Dimitri & language maintainers.
	There is some problem with language dependencies XML format. Language =
dependencies charecters coded as=20
	&#x**;=20
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=20
        if (c<0)=20
        {
	    result+=3D(QCString)"&#x" +=20
                  nibbleToHex((((uchar)c)>>4)&0xf)+
                  nibbleToHex(c&0xf)+";";
        }
        else=20
        {

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=20
        if (c<0)=20
        {
		char str[10];
		sprintf( str, "&#x%X;", theTranslator->toUnicode( c ) );
		result +=3D str;
        }
	  else
	  {