> Is it possible in doxygen to create a custom "todo"-like list from other
> commands? ... Everyone should add a special comment (e.g. "@review", as
> custom command) briefly documenting the changes. If those changes are all
> collected on a special page, and cross-referenced to the description, this
> would greatly simplify a review process.
Yes, it's possible, and it's easier than the documentation makes it seem.
I have several of these lists that I use for things as varied as
@todo_techpubs, @todo_eng_review (for things I want to highlight as needing
review), @todo_add_ask (for public entities that I'm unsure about
documenting, because there are public entities that are nevertheless not for
end user use, but are needed by internal modules.
I'll use the @todo_eng_review example since it corresponds most closely to
your use case.
In the Doxyfile, I have the following alias (the ending "\" chars are so
that I can have linefeeds in the Doxyfile for easier readability, but you
could put the entire command on a single line):
ALIASES += todo_eng_review="@xrefitem key_todo_eng_review \
\"Eng Review\" \"Eng Review Requested List\" \
Eng-review requested."
And you need to set the GENERATE_TODOLIST = YES.
Then when you use the @todo_eng_review command in the Doxygen comment
blocks, you'll get a page for the Eng Review Requested List.
I generally have two versions of my Doxyfile config files: one for a
review/non-release/internal version that sets "GENERATE_TODOLIST = YES", and
one that's for the actual production version where we don't want to expose
these internal things to the end user, with "GENERATE_TODOLIST = NO". This
way I don't have to strip out all these comments from the code, and can
carry things over to the next version.
If you go this route, then in addition to having "GENERATE_TODOLIST = NO",
you need to change the ALIAS, which I do as follows:
ALIASES += todo_eng_review="@todo Eng-review requested."
I found this necessary because the GENERATE_TODOLIST applies only to the
@todo comments, not the @todo_eng_review. So if I don't redefine the
@todo_eng_review back to @todo, I end up with that separate @xrefitem page
appearing in the output.
A bonus bit of info: I wanted these special @todo things to stand out in the
output, with a magenta vertical bar instead of the regular color. I created
a customdoxygen.css stylesheet, set "HTML_EXTRA_STYLESHEET =
customdoxygen.css", and in in the stylesheet, after the dl.todo entry, I
added an entry for dl.todo_eng_review. I kept everything the same as the
regular dl.todo, except for the color:
dl.key_todo_eng_review
{
margin-left:-7px;
padding-left: 3px;
border-left:4px solid;
border-color: #FF00FF; /* magenta */
}
HTH,
-Monique
------------------------------------------------------------------------------
Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
Francisco, CA to explore cutting-edge tech and listen to tech luminaries
present their vision of the future. This family event has something for
everyone, including kids. Get more information and register today.
http://sdm.link/attshape
_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
