If you like you can also use HTML commands inside the documentation blocks. * The dot above ends the sub sub item list. Here is an example that speaks for itself: /** You can end a list by starting a new paragraph or by putting a dot (.) on an empty line at the same indentation level as the list you would like to end. If you use tabs for indentation within lists, please make sure that TAB_SIZE in the configuration file is set to the correct tab size. Nesting of lists is allowed and is based on indentation of the items. Numbered lists can also be generated by using a minus followed by a hash or by using a number followed by a dot. Instead of the minus sign also plus (+) or asterisk (*) can be used. ( Portions © International Organization for Standardization 1986 Permission to copy in any form is granted for use with conforming SGML systems and applications as defined in ISO 8879, provided this notice is included in all copies.Doxygen provides a number of ways to create lists of items.īy putting a number of column-aligned minus (-) signs at the start of a line, a bullet list will automatically be generated. The list of special HTML4 character entities with their descriptions has been taken from: Character entity references in HTML 4. Doxygen won't see that as the closing either and give a warning. Note: It is explicitly forbidden to use 3 dashes before the closing greater than sign. The part will not be shown in the main documentation. Starts and ends a section of underlined text.įinally, to put invisible comments inside comment blocks, HTML style comments can be used: /*! Visible text */ Starts and ends a new table footer, currently ignored by doxygen. Starts and ends a new table header, currently ignored by doxygen. Starts and ends a new table data element. Starts and ends a new table body, currently ignored by doxygen. Starts and ends a piece of text displayed in superscript. Starts and ends a piece of text displayed in subscript. Starts and ends an inline text fragment with a specific style (HTML only) Starts and ends a section of text displayed in a smaller font. Starts and ends a section of strike through text. Starts and ends a section of inserted text, typically shown as underlined text. This command is written with its attributes to the HTML output only. Starts and ends an unnumbered subsubsection. Starts and ends an unnumbered subsection. Starts and ends a piece of text displayed in an italic font. Starts and ends a section with a specific style (HTML only) Starts and ends a piece of text displayed in a typewriter font. Starts and ends a section of detailed text that the user can open and close (in HTML output)) Starts and ends a section of deleted text, typically shown as strike through text. Note that only for C# code, this command is equivalent to \code (see ). Starts and ends a section of text displayed in a font specific for citations. Starts and ends a section of centered text. Starts and ends a piece of text displayed in a bold font. Starts a named anchor (if supported by the output format). Starts a hyperlink (if supported by the output format). Note that although these HTML tags are translated to the proper commands for output formats other than HTML, all attributes of a HTML tag are passed on to the HTML output only (the HREF and NAME attributes for the A tag are the only exception). Here is a list of all HTML commands that may be used inside the documentation.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |