RE: [Doxygen-users] Mid function special commands (like @todo)?
Brought to you by:
dimitri
From: Prikryl,Petr <PRI...@sk...> - 2001-09-05 14:29:50
|
No commands from inside a function body is interpreted. Add your @todo to the doxygen comment placed just above or just below the function header -- depending on your style. I would do something like this: /*! \brief Calculates something. The MemberFn() calculates something using well known algorithm. \param i This is the argument of the function which... @todo verify physical constants @todo obfuscate the constants meaningOfLife = 42 */ void SomeClass::MemberFn(int i) { // calculate some stuff float pi = 3.14f; float e = 2.71f; int meaningOfLife = 42; int mahabone = 13; // some more stuff } Note: the @todo and \todo is the same. I personally prefer the second way because of my previous LaTeX experience. Petr -- Petr Prikryl, SKIL, spol. s r.o., pri...@sk... > -----Original Message----- > From: Cory Riddell [SMTP:co...@co...] > Sent: Wednesday, September 05, 2001 3:22 PM > To: dox...@li... > Subject: [Doxygen-users] Mid function special commands (like @todo)? > > What happens to special commands that do not immediately precede a > function or member? For example: > > void SomeClass::MemberFn(int i) > { > // calculate some stuff > /// @todo verify physical constants > float pi = 3.14f; > float e = 2.71f; > /// @todo obfuscate the following constants > int meaningOfLife = 42; > int mahabone = 13; > // some more stuff > } > > I've looked at the doxygen output and I don't see the todo list > anywhere. Does the todo item have to be documented just before the > function definition? Is there a configuration switch that will tell > doxygen to extract mid-function todo's? > > -cory > > > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users |