RE: [Doxygen-users] Multiple comments -combining

[Wagner, V. <VW...@se...>]

If this were to be implemented (and it looks like the start of a pretty good
idea), I would like to see the comments from the source code being
optionally added.  I reason thusly:

The header file is "public".  Everyone who has access to it can read the
comments there if desired.
The implementation file (.c, .cpp, whatever) is generally information for
the developers.  Not everyone has access to this file.
At our office we generate two versions of Doxygen output... one for "users"
the other for "developers".
The ability to add information to the comments _must_, IMO, be selectable.

For generality here, I offer three different possibilities, two of which
require the comments processor to be given a new optional numeric argument.

1) the config file adds a numeric value which (if the 'number' on the
comments is < than the config, the comments will be added).  I choose
smaller, so that you can add more and more 'secret' comments to your hearts
content.

2) the config file adds a numeric value which if ANDED with the comment
argument results in a non-zero value, the comments will be added.  This
would allow for a set of up to (32??) "classes" of elements which could be
arbitrarily selected.

3) pretty complete generality:  Change the comments processor to accept an
arbitrary list of "ID"s to identify the "class"(es) to which this comment
belongs.  The config would also add an arbitrary list of "ID"s to identify
which "class"(es) of comments to include.


-----Original Message-----
From: jan...@co...
[mailto:jan...@co...]
Sent: Wednesday, 2001 November 14 10:27
To: dox...@li...
Subject: [Doxygen-users] Multiple comments -combining


Hi All

Is there any possibility to join multiple comments into one description?
I would like to have possibility to add the comments in header and in 
source code.
The rule that only one description is allowed is pretty limiting :-(.
I agree with the rule of only one brief description, but the detailed 
description should be possible to expand.
For example I would like to add some comments to the source code that is 
not my and I want to have comments in separated file.
If the consistency would be an issue there can be option in Doxyfile to 
turn this thing on/off.

Thanks

	Honza


_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users