RE: [Doxygen-users] why detailed documentation replace linefeed w ith space?
Brought to you by:
dimitri
From: Prikryl,Petr <PRI...@sk...> - 2002-01-14 10:26:20
|
Hi Chen, Please, read the documentation. Doxygen intentionally does not preserve 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 the arguments, the returned value, etc. Petr -- Petr Prikryl, Skil, spol. s r.o., (pri...@sk...) > -----Original Message----- > From: chen bin [SMTP:ch...@ya...] > Sent: Monday, January 14, 2002 9:34 AM > To: dox...@li... > Subject: [Doxygen-users] why detailed documentation replace linefeed > with space? > > my source code looks like this way: > > /*!************************************************************ > | Function name : fn > | Description : > | Return : static void > | Argument : void > | Caution : > |------------------------------------------------------------ > | Create : 2002-1-14 by Chen Bin > *************************************************************/ > static void fn(void ) > { > int a,b,c; > printf("now calling fn()"); > > } > > the output documentation: > > | Function name : fn | Description : | Return : static void | Argument : > void | Caution : > |------------------------------------------------------------ | Create : > 2002-1-14 by Chen Bin > > why? > > regards > > chen bin > |