Re: [boost] Copy editing documentation

From: Jody Hagins (jody-boost-011304_at_[hidden])
Date: 2007-03-16 09:59:53

On Mon, 12 Mar 2007 21:58:33 -0400
Hervé Brönnimann <hervebronnimann_at_[hidden]> wrote:

> I've used doxygen with great results a la doc book.  There is a  
> section at the beginning of each file , @file, where you can put the  
> usage examples, general documentation, rationales, etc.  Most people  
> think of doxygen as only the tags after each function...  With a bit  
> of patch and perl processing, it's used at Bloomberg to generate all  
> the documentation, and it works great (when the documentation is well-
> 
> written).  There can be a few glitches, but the doc always reflects  
> the actual code, and it makes editing the doc so much easier.   
> However when it is unfinished, it is not pretty.  That is perhaps the 
> 
> greatest disadvantage.

Do you have a sample set of files that you can provide as examples of
how to get doxygen to generate this information?