[Doxygen-users] \todo and the likes...
Brought to you by:
dimitri
|
From: Jakob P. <Jak...@cr...> - 2001-11-20 07:02:40
|
Hi!
I'm a newbie doxygen user who is trying to document a project using
doxygen. Doing it pretty naively/straightforward, I have gotten the basics
to work, i.e., \author, placing of dosygen comments etc. Still, there are a
few things that does work (even though I actually read the manual...:)
o \todo, \test, \bug - despite setting "GENERATE_TODOLIST = YES" etc.,
todo's etc. are nowhere to be found in the generated documentation.
o \date - even though I use it, no dates appear anywhere.
Example code:
/**
* Imports types and elements from a file.
*
* The operation should be part of a transaction which is rolled back if
anything goes wrong.
* If the file contain application type or data elements already present
in DB, the method will fail.
*
* @author Me
* @date Nov 2001.
*
* @param T A transaction.
* @param fileName The fileName to be read.
*
* @throw import_exception If something goes wrong.
*
* @return A vector of names of the types that were imported
*
* @todo Testing 1-2
*
* @test Do this.
* @test Do that.
*
* @bug Dummy - nothing is really wrong.
*/
vector<string> importElements(Transaction&, string&);
TIA
-- Jakob
|