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. When used for analysis, Doxygen uses its parse tree to generate diagrams and charts of the code structure. */ Include additional documentation pages in HTML or Markdown format Doxygen (/ d k s i d n / DOK-see-jn) is a documentation generator and static analysis tool for software source trees.When used as a documentation generator, Doxygen extracts information from specially-formatted comments within the code. 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. The doxygen online documentation is also indexed by your favorite search engine, which will make a search for clang and the AST nodes class name usually turn. 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 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 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |