RE: [Doxygen-users] multiline /// comments

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

I use input filters. The FILTER_SOURCE_FILES tag and the INPUT_FILTER
tag in the project file can be used to specify a program that should be
invoked to filter for each input file. Doxygen uses the output that the
filter program writes to standard output.=20

I use use input filters to:
- Change comment styles from //! into /**...**/.=20
- Change class definitions into a format that is more standard for
Doxygen reporting.
- Change the @bug Doxygen command into @lim command that is defined in
the project file in the ALIASES section.=20
- Change program files (e.g., Perl, IVE) into a format that is more or
less recognized by Doxygen.Refer to the Doxygen documentation.

Attached is a simple Perl program that changes from //! comments to /**
... **/ comments. You'll easily be able to modify it to support ///
comments.

FWIW, /** ... **/ comments are more reliable because they are treated as
a block. This is important when the comments appear at the beginning of
a file and contain @file. When not in a block, Doxygen can sometimes
pick off individual //! comments from the file header and attach them to
the first valid code item it sees, like a #define.

The input filters mean than I can appease SW Engineering whims about
comment styles.

More tools to follow. The draft documentation is complete, but I need to
get it reviewed and approved.

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: Gedalia Pasternak [mailto:ge...@tu...]
> Sent: Thursday, January 17, 2002 9:24 AM
> To: dox...@li...
> Subject: [Doxygen-users] multiline /// comments
>=20
>=20
>=20
> Hello all,=20
>   After poking around the documentation for a while, I found=20
> that doxygen will concatate a multi-line /// comment into the=20
> brief description. I was wondering if there is any way to get=20
> doxygen to generate both the brief and the "more..." comments=20
> from multi-line comments. Like it would for /** comments. =20
> Our project leads really don't like the /** style comments,=20
> but I'm not thrilled with shoving all comments into the brief=20
> info block.
>  =20
>   Thanks, it's an awesome tool.
>=20
> -Gedalia Pasternak
>=20
> ---------------------------------------------------------------
> Graphics Engineer - www.TurbineGames.com	 =20
> AIM: gedaliap
> 781.407.4428
> ---------------------------------------------------------------
> Fight Entropy!!!  Fight Entropy!!!  Figth Etnropy! !
> iFgth Etnrop!y ! giFth tErno!py !  giFt htrEno!p y! --- Well maybe
> not...
>=20
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>=20