Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Can I create a global todo list in doxygen?

Tags:

doxygen

I am new to Doxygen and have been able to create todo items in a module. Can I create a global todo list or is there a better way to get all the todo items in one place?

like image 278
user1812523 Avatar asked Nov 09 '12 14:11

user1812523


1 Answers

All the to do items (created using the doxygen command \todo) appear together on a page called "Todo list", which is located under the "Related Pages" tab (see the image below). This page is a "global" to do list for the whole project. Notice that a page is also created for lists of bugs (cf \bug).

"Related Pages" generated by doxygen, which links to the global todo list.

You can also make your own custom pages appear under the "Related Pages" tab using the generalization of the \todo and \bug commands, \xrefitem. See the \xrefitem documentation for an example which adds a "Reminders" page.

like image 188
Chris Avatar answered Sep 27 '22 22:09

Chris