Hi Doxygen users
I have recently tried out Doxygen, and I must say that I also miss the =
possibility to take with me the comments in front of a function into my =
documentation. I have also tried out CCrider, which have this option. I =
used Doxygen on a project which was finished, and I wouldn't change too =
much in the code to get Doxygen to work. The only way I could get it as I =
wanted, was to implement the comments as this:
/*!\verbatim
************************************************************
| Function name : fn
| Description :=20
| Return : static void=20
| Argument : void
| Caution :=20
|------------------------------------------------------------
| Create : 2002-1-14 by Chen Bin
************************************************************\endverbatim
*/
and since I used fixed with fonts in my programming editor, the coloums =
was also preserved using this method.=20
But if I intend to use Doxygen on a new project, maybe I would try to =
write my comments more according to what Doxygen needs.
Fred I Tallaksen
R & D JOTRON electronics a.s
>>> "Prikryl,Petr" <PRI...@sk...> 14.01.02 11:03 >>>
Hi Chen,
Please, read the documentation. Doxygen intentionally does not preserve=20=
formatting of the comments (if not prescribed). In your case, you have
probably generated HTML output. The HTML document ignores spaces
and linebreaks in your output. The bar character '|' is not given any
special meaning, nor any other character that is used inside your
comment. You have to use special doxygen commands to mark=20
the arguments, the returned value, etc.
Petr
--=20
Petr Prikryl, Skil, spol. s r.o., (pri...@sk...)
> -----Original Message-----
> From: chen bin [SMTP:ch...@ya...]=20
> Sent: Monday, January 14, 2002 9:34 AM
> To: dox...@li...=20
> Subject: [Doxygen-users] why detailed documentation replace =
linefeed
> with space?
>=20
> my source code looks like this way:
> =20
> /*!************************************************************
> | Function name : fn
> | Description :=20
> | Return : static void=20
> | Argument : void
> | Caution :=20
> |------------------------------------------------------------
> | Create : 2002-1-14 by Chen Bin
> *************************************************************/
> static void fn(void )
> {
> int a,b,c;
> printf("now calling fn()");
> =20
> }
> =20
> the output documentation:
>=20
> | Function name : fn | Description : | Return : static void | Argument :
> void | Caution :
> |------------------------------------------------------------ | Create :
> 2002-1-14 by Chen Bin=20
>=20
> why?
>=20
> regards
>=20
> chen bin
>=20
_______________________________________________
Doxygen-users mailing list
Dox...@li...=20
https://lists.sourceforge.net/lists/listinfo/doxygen-users
|
