- #PARAM DOXYGEN HOW TO#
- #PARAM DOXYGEN CODE#
These are placed with the definition of the tag can be used to document the purpose and meaning of params for functions. 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.
#PARAM DOXYGEN 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 Documenting an Applicationĭoxygen comment blocks are easy to create. Template page for Subdirectories of Libraries. 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. See as example the existing math/doc/Math.md file. Inside page you can reference to groups or other pages using the Doxygen commands \subpage and \ref. This page provides a description of the Histogram library. The file should contain, in addition to the package description, the Doxygen command \page which defines the internal page name (used to reference that page) and The pages should be included in a file with name as the package name and the. Provide a general documentation of the package. One can add extra pages for the documentation in HTML or Markdown format (preferable) in the package/doc directory (e.g. */ Include additional documentation pages in HTML or Markdown format For example in the class TH1, which is part of the Hist group one should add /** Then one needs to add in the class description comments the \ingroup tag. The Histogram library is documented in the class TH1. In order to do this, you need to define first somewhere, as a code comment or in a separate page a You can group the classes according to the corresponding packages (e.g. See the following example: /// Possible option values are: /// /// option | description /// -|- /// "SAME" | superimpose on top of existing picture /// "L" | connect all computed points with a straight line /// "C" | connect all computed points with a smooth curve /// "FC" | draw a fill area below a smooth curve /// Grouping classes in modules Markdown tables are very convening for tabulated documentation. The results are placed by default at $ \. Generate the complete set of documentation. The automatic daily Jenkins procedures will #PARAM DOXYGEN HOW TO#
How to generate the doxygen documentationĭevelopers may generate the documentation by hand to see the results of the current changesīefore committing them to the repository. Here you will find a number of conventionsĪnd tips to be used in source code to generate proper documentation. The ROOT team has adopted Doxygen for generating Include additional documentation pages in HTML or Markdown format.Useful tips for common documentation artifacts.How to generate the doxygen documentation.
0 kommentar(er)
