By convention in Rosetta3 all functions must have details tags. what must be true for the function to work), how the function carries out it function, and what will be true when the function returns. This message should give a user an idea of when it is valid to call this function( i.e. These included in the header file along with the declaration of the tag supplies a more detailed description. By convention in Rosetta3 all functions must have brief tags. This message should tell what happens in the function. Common Doxygen Tags Common Source Document tag supplies a brief description of a function for doxygen pages.
Doxygen tutorial code#
To end the comment block type asterik and then forward slash.īy taking a few minutes as you are writing your code to write comment blocks you can tell future developers what you intended and make their life more productive and easier.
To start a new paragraph add an empty line These next few lines will form a comment block ///This line will be included in the Doxygen comments for this function/class/fileĬommenting multiple lines is just as easy. For line comment just insert a triple forward slash.
Template Doxygen Page for New Category of Source Files.Each of the below template pages are found in doc/template_doxygen_pages. On the simplest level you can copy them to an appropriate location and fill in the fields with the appropriate information. These pages are intended as starting points.
Writing Descriptive Comments in DoxygenĪ few general template doxygen pages have been created to help you document higher level concepts in Rosetta.
0 kommentar(er)
