RE: doxygen for cfengine

[Wheeler, John]

cscope and ctags are also excellent tools for answering the questions
below. Both have the added benefit of integrating into vim. Not knocking
the docs, but I've found that with ctags/cscope I can not only answer
the questions below, but also see the context of the code, and more
importantly make the changes I need.

> -----Original Message-----
> From: address@hidden
[mailto:bug-cfengine-
> address@hidden On Behalf Of Eric Sorenson
> Sent: Wednesday, January 26, 2005 5:58 PM
> To: address@hidden
> Subject: doxygen for cfengine
> 
> I got a round tuit last night and ran the cfengine sources through
> doxygen. It took about 5 minutes to complete (on my 2.5G Athlon!)
> and ended up looking like this:
> 
>     http://eric.explosive.net/cfdoxy/
> 
> I wanted to find all the places that referenced CanonifyName to
> see how much trouble it would be to make it reentrant, and it
> turns out it wouldn't be so bad.
> 
>     http://eric.explosive.net/cfdoxy/filenames_8c.html#a7
> 
> All of the function names in the graphviz call graphs are imagemaps
> that will take you to the definition if you click 'em.  Don't know
> if this is helpful to anybody, but I thought it was neat.
> 
> Going forward, doxygen might be a good way to do internals
documentation
> with a minimum of fuss. An extra * on the opening wing of a comment
> is all it takes to start including docs in the generated files, a'la
> 
>     http://www.stack.nl/~dimitri/doxygen/docblocks.html
> 
> But at the very least, with no additional work, it's a good way
> to get a handle on the flow of execution.
> 
> --
> 
>  - Eric Sorenson - Explosive Networking - http://eric.explosive.net -
> 
> 
> _______________________________________________
> Bug-cfengine mailing list
> address@hidden
> http://lists.gnu.org/mailman/listinfo/bug-cfengine