Re: [Doxygen-users] TODO Lists in CPP implementation files
Brought to you by:
dimitri
|
From: Edmund G. <con...@ya...> - 2001-11-30 07:50:51
|
re:
> When I generate HTML on this code with Doxygen, the todo list contains the
> first \todo item, but not the one in the .cpp file. This behavior greatly
> reduces the utility of the Todo feature itself.
I haven't used Doxygen on C++ for a few months now, but I think that it
doesn't actually look at comments inside function definitions. If you
put the todo above the main function then it will work.
e.g:
/**!\brief entry point of applications
*
* some long description
*\todo DOXYGEN SHOULD PICK THIS UP <--- move here
*/
int main (int argc, char* argv)
{
TestClass myTestClass;
std::cout << myTestClass.GetValue() << std::endl;
std::cout << myTestClass.GetAnotherValue() << std::endl;
};
also re:
>class TestClass
>{
>public:
> inline int GetValue() {return mValue;};
> TestClass(){mValue = 42;};
> int GetAnotherValue();
>
> /// \todo THIS APPEARS IN THE T0-DO LIST
>
>protected:
>private:
> int mValue;
>};
beware that this causes the todo to link to the documentation for the
mValue variable (which may or may not have been what you were expecting?)
Edmund.
|