![]() * Verbose description of Parameter in the method’s Return value of Verbose explanation of return values When updating methods, update comments like Brief method description Methods can be tagged in a number of ways, but in general the and tags are used before a method’s declaration or implementation. When updating structs, update comments like Brief struct Struct Name ![]() Int var3 /**< Comment about private member Brief method descriptionĪ struct can be tagged in the same way a class, but it is best to use the tag. Int var2 /**< Comment about protected member Brief method description * Verbose description of Parameter in the method’s Return value of method Int var1 /**< Comment about public member Brief method description When updating classes, update comments like this: Having the and supports tractability as the system is versioned throughout the software lifecycle. It also helps when files contain multiple classes.Ĭlasses can be tagged in a number of different ways, but in general they are tagged using the and tags before the class declaration. This supports generation of a file list tab on the main page. This can be done using the tag at the top of the file.Įxample of HAL system Doxygen Guideline (Note: source code was also modified to support correct generation of documentation)Ī file should contain the tag at the top of the file. There should be a header file containing only Doxygen tags or a separate Doxygen file that acts as a guide for the components, classes, methods, and variables (e.g. Tags using the “\tagname” style are considered Qt style Doxygen tags. * is an example of a Java doc style Doxygen tag, since it uses the symbol. Additionally, it reduces issues when generating documentation. Doxygen style should follow a consistent format to aid development across different IDEs. HTML generation has support for more plugins and is easier to refactor as the system changes. Doxygen documentation can be generated in many formats(HTML, LaTeX, RTF, PDF, DOC).
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |