doxygen-users

[Doxygen-users] TODO Lists in CPP implementation files

[Allan M. <all...@in...>]

Is there any way to get Doxygen to consider both the .h and .cpp files when
building its to-do list?  As an example, the code below contains \todo
commands in both test.h and test.cpp.

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.

Any ideas?

Allan Metts -- Atlanta


//---------test.h--------------

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;
};


//--------test.cpp--------------

#include <iostream>
#include "test.h"

int TestClass::GetAnotherValue()
{
  return 43;
};

int main (int argc, char* argv)
{
  TestClass myTestClass;
  std::cout << myTestClass.GetValue() << std::endl;
  std::cout << myTestClass.GetAnotherValue() << std::endl;

  /// \todo DOXYGEN DOESN'T PICK THIS ITEM UP!

};

Re: [Doxygen-users] TODO Lists in CPP implementation files

[Edmund G. <con...@ya...>]

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.

RE: [Doxygen-users] TODO Lists in CPP implementation files

[Allan M. <all...@in...>]

To Rod, Edmund, and Prikyrl:

Moving the \todo items outside of the function body does indeed do the
trick -- thanks!

Rod-- Unfortunately, I wasn't able to generate in-function Todo items using
the \function tag as you described.  I was, however, able to generate
multiple todo's for one function by placing them outside of the function
body.

It's a bummer that you can't drop the todo's inline with the code you're
writing.  Is anyone aware of another tool (other than grep, I guess) that's
good for keeping track of the things you intend to get back to?

A-----


> -----Original Message-----
> From: dox...@li...
> [mailto:dox...@li...]On Behalf Of Edmund
> Green
> Sent: Friday, November 30, 2001 2:50 AM
> To: Dox...@li...
> Subject: Re: [Doxygen-users] TODO Lists in CPP implementation files
>
>
> 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.
>
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users