Re: Silent dropping of documentation

On Mon, Mar 26, 2007 at 09:18:33PM +1000, Brendon Costa wrote:
> I would like to be able to perform a union of this documentation so that
> if you look at the documentation for MyFunction you will see something like:
> 
> Brief for function.
> 
> Detail 1 for function.
> Detail 2 for function.

One thing to bear in mind is how you would tell Doxygen which detail
should come first in the unioned version.

> Is there anything that can achieve this currently?

Not trivially, I think.

> Basically i have additional documentation for every function that is
> automatically generated by an external program that i want to
> include in addition to the user defined documentation.

I haven't tried this, but you might be able to use \copydoc.  For
example have your generated documentation use slightly modified
function names so that Doxygen thinks the documentation is for some
other function, and then use \copydoc to bring that into the function
that it's really meant to be with.  I don't know if you can then stop
Doxygen from outputting the fake function in the final documentation,
though.

In the few cases where I need to programmatically generate the input
to Doxygen, I actually pre-process the code file itself.  For example
for one set of functions I have m4 macros to produce LaTeX pictures
which would be very tedious to type out and maintain by hand.  The
original code is in "foo.h.m4", and the Makefile automatically
generates "foo.h" from that as part of the build.  It's ugly, but it
does work.

                                                  -Dave Dodge

-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys-and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV