*/ 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 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.
