The most frequent use cases for this are when you want to document enumeration values and member variables. In some cases it makes sense to place the documentation comment behind its element. / This is the brief description for a class In this case you do not have to explicitly specify what you want to document - Doxygen is clever enough to find out by itself the type and name of the element that the comment belongs to. Usually a comment block is placed just before the element it documents. ![]() Where to place documentation Documentation before the element (default) When enabled Doxygen pre-processes all comments according to the Markdown format, which allows for more readable documentation. Unless you explicitly disable this in the Doxygen configuration file (the controlling tag is `MARKDOWN_SUPPORT`), you can mix Doxygen formatting with Markdown formatting. Using "\" just looks unnatural to me, whereas is much more agreeable to my eyes. the Unix shell, regular expressions, C/C++). My dislike for this is mostly based on "\" being the escape character in a lot of technologies that I am used to (e.g. The other command markup style uses the "\" (backslash) character as the command prefix. There are several styles how a command can be marked up, but my personal favourite is the JavaDoc style where commands are prefixed with an (at) character.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |