Subject: Re: Thanks for Doxygen, One Question
From: Jesper Skov (jskov@redhat.com)
Date: Wed Jan 24 2001 - 16:56:52 CST
>>>>> "Randy" == Randy Kramer <rhkramer@fast.net> writes:
Randy> The way I understand it works is by finding comments in the
Randy> source code marked with special symbols. Is there a way to
Randy> create more than one "level" of such comments, and then
Randy> selectively print out only one or both levels? I might feel
Randy> the need to add some comments at what I would call a newbie
Randy> level. Most developers would not want to see them, but they
Randy> might be helpful to newbies.
No, I don't think so.
Doxygen can only pull out one section for a particular function. It
looks like this:
/*!
Short description
\param foo Foo description
\param bar Bar description
...
\retval xx XX description
\retval yy YY description
...
\return Return value description
Long function description....
........
......
*/
So it's not suitable for in-line comments in the code, which I suspect
is what you are after. If it's just additional very explicit
paragraphs about the functionality of the function body, they should
be OK to add to the above.
Jesper
This archive was generated by hypermail 2b25 : Wed Jan 24 2001 - 16:57:09 CST