> on different places. Therefor, I would like to use some comment extractor
> to help me build a reference.
> 
> > In my experience the problem with
> > Doxygen and templates is not so much the parsing of the templates
> > as Dave suggests below, but rather splitting and refining down 
> > the output in a logical structure as you suggest in your mail.  
> 
> This is exatly the point. Doxygen parsed code quite well, but the output
> was confusing and not very nice. Doxygen cannot format templated structures
> very well.
> 
> > The easy thing is to run all the code.  The hard thing is 
> > to actully document the components in the code and split
> > things into logical groups.

I would suggest doing a small experiment with your code.  Annotate
a few functions and then generate the xml and run it into boost book
to get a feel for the output.  One thing I don't know is how 
template parameter descriptions are translated for template
functions.  For example if you did this:
/** The f function short description.
 *  The f function long description...   
 [EMAIL PROTECTED] P1 blah blah (template first parameter description)
 [EMAIL PROTECTED] P2 blah blah (template second parameter description)
 [EMAIL PROTECTED] fparm1 Function param description
 */
template<typename P1, typename P2>
f(const P1& fparm1)
...

So you might want to try something like this out.  Also, if you use doxygen,
 based on your prior comments you might want to run the output in groups:
layer2 and layer3 to control the set of output.  Layer 1 should be ignorable
by setting doxygen to not process undocumented code.

HTH,

Jeff




-------------------------------------------------------
This SF.Net email is sponsored by: INetU
Attention Web Developers & Consultants: Become An INetU Hosting Partner.
Refer Dedicated Servers. We Manage Them. You Get 10% Monthly Commission!
INetU Dedicated Managed Hosting http://www.inetu.net/partner/index.php
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests: 
https://lists.sourceforge.net/lists/listinfo/boost-docs

Reply via email to