[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Discuss-gnuradio] C++ Commenting for Doxygen
From: |
Eric Blossom |
Subject: |
Re: [Discuss-gnuradio] C++ Commenting for Doxygen |
Date: |
Mon, 26 Mar 2007 15:19:33 -0700 |
User-agent: |
Mutt/1.5.9i |
On Mon, Mar 26, 2007 at 05:05:38PM -0400, Gregory W Heckler wrote:
> Is there a proper way to format comments in my DBS-RX driver's source to
> be included in the doxygen documentation? I would like to do this prior
> to submission of the driver. Thanks.
>
> Greg Heckler
Sure, thanks for asking.
We use the
/*!
* doxygen comments go here...
*/
format.
There's a pretty big user manual here:
http://www.stack.nl/~dimitri/doxygen/manual.html
and this describes the directives:
http://www.stack.nl/~dimitri/doxygen/docblocks.html
But the main things we're looking for are
/*!
\brief one liner about class or free function
Followed by a paragraph that talks about what it does, including the
parameters. See the \param directive.
*/
Eric