Re: [Doxygen-users] why detailed documentation replace linefeed with space?

[Olivier P. <pa...@la...>]

chen bin wrote:

> my source code looks like this way:


[...]

 
> the output documentation:
> 
> | Function name : fn | Description : | Return : static void | Argument : 
> void | Caution : 
> |------------------------------------------------------------ | Create : 
> 2002-1-14 by Chen Bin
> 
> why?


I think I can answer this one : embedding documentation
in doxygen comments isn't enought to get them formatted
properly. If you insist on keeping your data this way,
inserting "<br>" or somethink like that should give you
proper linefeeds.

But I think a better way would be to use Doxygen's
habilities by expressing things like that :

/*!
A short description.
A long description of what this function do.
\arg <name> <comment>
\returns <comment>
\warning <comment>
\author Chen Bin
*/

Etc (have a look at the documentation for more commands).
Note that the function name and the type of return don't
have to be documented, doxygen will extract them anyway.

Regards,
Olivier.