RE: [Doxygen-users] Multiple comments -combining

[Glenn M. <gle...@vo...>]

You might be able to get this to work if you added a prototype line to
the description to force the comment to go where you want. The only
problem with this is that the line with the prototype has to be
maintained. If you change your code without changing this line, it will
break.

For example, assume that you have a class with a member function
HHH::bogus(int doofus) defined. It appears in the header and source
file. Let's assume that you want the source file to be the "master". To
any comment blocks in the header file that are to appear with the
"master" documentation in the source file, you would add at the
beginning:

// h file
/** @fn bogus(int doofus)
 ** Additional comments about bogus.
 ** More comments about bogus.
 **/
HHH::bogus(int)

// cpp file
/** @brief this is all about bogus.
 ** @param doofus is not important.
 **/
HHH::bogus(int doofus)

I may have this backwards in terms of what you have to use as the
master.

I do know that by adding a prototype statement to a comment block, I can
"route" the comment from the closest, logical code element to another
code element that was defined.

I'm not sure how this will work when you want it to go to essentially
the same thing. This is why something "non-standard" might help. If you
cpp file had the complete definition including variable name but your h
file only had the variable type, the @fn prototype statement won't be
confused as to where it belongs.

The two obvious problems are: (1) your h/cpp definitions differ, (2)
your adding another prototype definition that has to be maintained.

HTH,
Glenn Maxey
Technical Writer
Voyant Technologies, Inc.
1765 West 121st Avenue
Westminster, CO 80234-2301
Tel. +1 303.223.5164
Fax. +1 303.223.5275
gle...@vo...



> -----Original Message-----
> From: jan...@co...
> [mailto:jan...@co...]
> Sent: Wednesday, November 14, 2001 8:27 AM
> To: dox...@li...
> Subject: [Doxygen-users] Multiple comments -combining
>=20
>=20
> Hi All
>=20
> Is there any possibility to join multiple comments into one=20
> description?
> I would like to have possibility to add the comments in header and in=20
> 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=20
> description should be possible to expand.
> For example I would like to add some comments to the source=20
> code that is=20
> not my and I want to have comments in separated file.
> If the consistency would be an issue there can be option in=20
> Doxyfile to=20
> turn this thing on/off.
>=20
> Thanks
>=20
> 	Honza
>=20
>=20
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>=20