Silent dropping of documentation
Brendon Costa <[email protected]>
| Newsgroups | gmane.text.doxygen.devel |
|---|---|
| Message-ID | <[email protected]> |
If i use doxygen to generate documentation from the following code, it
does not perform a "union" of the two sets of documentation for the one
function and it also does not emit any warnings. It just uses the
documentation from the first block and ignores the second.
/** \brief Brief for function.
*
* Detail 1 for function.
*/
void MyFunction()
{
}
/** \fn MyFunction()
* Detail 2 for function.
*/
I would have expected a union of the two blocks to have been achieved
where possible, otherwise at least a warning to have been emitted
indicating that the documentation from the second block is being discarded.
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.
Is there anything that can achieve this currently? 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.
Is there anything existing in doxygen that will achieve this and if not
would anyone mind me trying to add something like this that works either
with the above \fn command or a new command specifically for that purpose?
Thanks,
Brendon.
-------------------------------------------------------------------------
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