All these tags are used to highlight the section of the documentation as especially noticeable in comparison with other sections that are not tagged. All of them are used to draw the reader’s attention to the marked paragraph.
Note - this is the most common tag and is used in most cases when you want the reader to "notice" the issue described in the section.
The Attention tag can be used to highlight a critical note that you do not want to ignore.
The Warning tag should be used instead of Attention when there may be negative consequences to consider whether the reader is reading how he uses the documented element.
Note and Note tags can be used for notes of lesser importance. If you want to describe something in the sense of “oh by the way,” it’s useful to use the Remark tag for it.
The Todo tag is used differently than the others you specified. It is commonly used to indicate that the code described in a comment has one or more incomplete aspects. This warns both users of the code and authors of the code that the function or error must be fixed in a later version of the corresponding section of the code. Doxygen has a cool feature in which it will list all Todos together in its section in the generated output. This can be disabled by editing the Doxyfile and changing the line GENERATE_TODOLIST = YES to GENERATE_TODOLIST = NO .
The Error tag associated with the Todo tag, which can be used specifically for marking documentation describing a software error. Similarly, Doxyfile has a GENERATE_BUGLIST = YES , which causes all errors to be reported in their own section; this can be disabled using GENERATE_BUGLIST = NO .
sifferman
source share