[Bayes++] Doxygen documentation
Brought to you by:
mistevens
|
From: Fredrik O. <fre...@id...> - 2005-09-25 21:03:00
|
The automatically generated Doxygen documentation for Bayes++ does not seem
to include the comments found in the code. This is probably due to the fact
you've written the comments between the function signature and the function
body; while Doxygen prefers comments to be written before the function
signatures (or after the body). You will also need to start each comment
with double asterix' ("/**") to mark them as code-documentation.
I would gladly help you in the task of "fixing" the comments to comply with
Doxygen if you're interested in any help.
A simple example of Doxygen code-comments can be found on
http://www.stack.nl/~dimitri/doxygen/docblocks.html
regards,
Fredrik Orderud
Ph.D student in Computer Science, NTNU
|