The doxygen tool supports a limited set of markdown format in the comment block including links, tables, lists, etc. Any text on these lines, including tag declarations, should start after a single space after the asterisk. See the Example section below.Įach line in the comment block between the /** and */ lines should start with a space followed by an asterisk. The block may be indented to line up vertically with the item it documents as appropriate. The block must be placed immediately before the source code line to which it refers. Do not add dashes - or extra asterisks ***** to the first and last lines of a doxygen block. **ĭoxygen comment blocks start with /** and end with */ only, and with nothing else on those lines. Use the following style for block comments describing functions, classes and other types, groups, and files. includeĮmbedded markdown files and source code directories to process Here are some of the custom options in the Doxyfile for libcudf. The doxygen process can be customized using options in the Doxyfile. This document provides guidance on which commands/tags to use and how to use them in the libcudf C++ source code. There are almost 200 commands (also called tags in this document) that doxygen recognizes in comment blocks. Doxygen recognizes and parses block comments and performs specialized output formatting when it encounters doxygen commands. The doxygen tool is used to generate HTML pages from the C++ comments in the source code. 2019-2021)Ĭhanging the copyright year may not be necessary if no content has changed (e.g.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |