On Tuesday 23 March 2004 08:08 am, Patrick Earl wrote:
> On Monday 22 March 2004 16:53, Dave Fancella wrote:
> > All,
> >
> > There's a new jazz.doxy file in the root. If you have doxygen
> > installed, you can just type 'doxygen jazz.doxy' from the root.
> > Then open a browser at 'doc/html/index.html' to browse the class
> > documentation.
> >
> > Anyone not know how to document code with doxygen? I'll be happy
> > to throw up the rudimentary stuff I do here...
>
> The whos whatsit? Actually, I've never used it before. I wouldn't
> mind seeing some samples and/or a pointer to reference material.
http://www.doxygen.org/
Here's what I do, and this is really all I do, but I'm not opposed to finding
out cooler things to do. :)
In the header file, over each member declaration, something like this:
/// This is a brief description of this thing
Note the three slashes.
In the .cpp file, over each member definition, something like this:
/**
* This is a long description
* that spans multiple lines.
*/
You can also add this:
/**
* This is a long description of the member.
*
* params
* @firstargument
* description
*/
You've probably seen comment blocks like that before, I'll bet. In any case,
note the extra asterisk on the first line of the comment block: /**
The three slashes '///' and the extra asterisk '/**' tell doxygen that *this*
code block documents the member that appears right after it.
if you have a block like this:
// \todo
// Fix this stupid bug *name bug here*
Then doxygen will generate a todo list.
When you run doxygen, using the jazz.doxy file, doxygen will recursively scan
every source file in the jazz/src directory looking for those comment blocks
and build documentation in the jazz/doc directory. It'll build both html and
latex versions of the docs. I figure we just distribute the doxy file and
tell people if they want to build the documentation, run doxygen on it.
Dave
> Patrick
>
>
>
> -------------------------------------------------------
> This SF.Net email is sponsored by: IBM Linux Tutorials
> Free Linux tutorial presented by Daniel Robbins, President and CEO of
> GenToo technologies. Learn everything from fundamentals to system
> administration.http://ads.osdn.com/?ad_id=1470&alloc_id=3638&op=click
> _______________________________________________
> jazzplusplus-devel mailing list
> jaz...@li...
> https://lists.sourceforge.net/lists/listinfo/jazzplusplus-devel
--
Visit my website!
http://www.davefancella.com/?event=em
You know you have a small apartment when Rice Krispies echo.
-- S. Rickly Christian
|
