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.
Doxygen custom tags code#
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
Doxygen custom tags 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.Sollten Sie Schwierigkeiten beim Oeffnen dieser E-Mail haben, wenden Sie sich bitte an den Absender oder an Please refer to for our confidentiality notice. Demgemaess nehmen wir per E-Mail auch keine rechtsverbindlichen Erklaerungen oder Auftraege von Dritten entgegen. Wir verschicken daher keine rechtsverbindlichen Erklaerungen per E-Mail an Dritte. Wir weisen darauf hin, dass rechtsverbindliche Erklaerungen namens unseres Hauses grundsaetzlich der Unterschriften zweier ausreichend bevollmaechtigter Vertreter unseres Hauses beduerfen. Das unerlaubte Kopieren oder Speichern dieser Nachricht und/oder der ihr etwa beigefuegten Anhaenge sowie die unbefugte Weitergabe der darin enthaltenen Daten und Informationen sind nicht gestattet. Anschliessend moechten Sie bitte diese Nachricht einschliesslich etwa beigefuegter Anhaenge unverzueglich vollstaendig loeschen. Wenn Sie nicht der richtige Adressat sind oder diese Nachricht irrtuemlich erhalten haben, informieren Sie bitte sofort den Absender über die Antwortfunktion. Try Boundary one-secondĭoxygen-users mailing Nachricht einschliesslich etwa beigefuegter Anhaenge ist vertraulich und kann dem Bank- und Datengeheimnis unterliegen oder sonst rechtlich geschuetzte Daten und Informationen enthalten.
Q: What is the most annoying thing in e-mail?īetter than sec? Nothing is better than sec when it comes to May be you can use >ALIASES = Angelegt am:"<< or similar instead?Ī: Because it messes up the order in which people normally read text. > that wouldn't seem really nice, but certainly sufficient. > don't use anyway, so if there were a way to accomplish this, > to and providing another translation for the latter? We > Does anybody have an idea? Is there a way to play around with mapping > views the portion as part of the previous tag and just puts > with a date, then with a value), doxygen apparently > - If the sequence is mixed (e.g., first with a name, then > - The entry will never be aligned with the other heading entries. > the tag and just printed the date without any context. > 1-argument command, but that didn't help - the output simply ignored > As the subject suggests, I'd like to have this treated just like the The tag is part of the header section where stuff > As the name suggests, this just marks the date the specific source > We're using a non-standard Javadoc tag in a lot of our classes. > I've been playing around with the ALIASES configuration part, but April 2012 18:49Īn: Re: Custom Tag like 17:34, schrieb Klein, Raimund: :-)Į-Mail Hamburg - Amtsgericht Hamburg HRA 42659 So my lesson of the day is that \par translates to etc.
Doxygen custom tags full#
The full replacement includes an additional newline: