An example of this usage can be found with the lib_algebra, lib_disc and lib_grid modules. Multiple \exception commands are possible.Įverything except of pages can be grouped into Modules showing up in a separate group in the documentation. it can not be longer than one line.ĭocumenting the parameter name of the function with a short descriptive text and whether it is only an input ( in) or output ( out) or both ( in,out) paameter.ĭocumenting the return value of a function with a descriptive text.ĭocumenting possible exceptions emitted by a function with their defined type and a descriptive text. This brief text ends at the line it is defined in, i.e. It is as well repeated in the detailed documentation of that function, but separated from the detailed description. The first can be used several times.Ī very short description of the function showing up in the member list at the top of each class documentation page. To define author and date of creation, the commands \author and \date are available. Remarks The lazy verariant might not work in full functionality with Doxygen version prior to 1.8.0.ĭocumenting Classes, Funktions and Variables with a unordered item of lover level where the source code but not the rendered text spans over several rows.Note The indentation of the text is important! For the ordered list, append a hash (' #') to the dash. Lazy - simple Markdown Same possibilities as with HTML, but with simple dashes (' -') followed by a whitespace defining each element. pure - HTML-Tags There are HTML tags for two kinds of lists:.There are two options: One pure and one lazy with a little remark. \verbatim - \endverbatim, same as above, but without the fancy syntax highlighting or linking.It offers basic syntax highlighting and automated linking to functions and classes found somewhere else in the documentation. \code - \endcode to display source code.Especially for displaying source code the following are usefull: The second type of paragraphs are defined by a starting and closing command. \warning Check your pointers! Warning Check your pointers!.Remarks Make sure your development toolchain is functional. \remarks Make sure your development toolchain is functional.Note It might be a good thing to bookmark this page. \note It might be a good thing to bookmark this page.Warning If used within lists or other blocks of HTML, please make sure there is one empty line between the end of such a paragraph and e.g. Note These paragraphs end at the start of the next such paragraph or at an empty line. There are some special paragraphs available, which do not only look nice but come sometimes rather handy. \subsection) or arbitrarily defined anchors ( \anchor target) somewhere in documents within the include path of Doxygen. Targets accessible by the \ref command are either defined pages ( \page), sections (e.g. In case "Title" is not given with the \ref command, the name of the section or page is used. To create custom links, either the HTML tag ( This is a link) or the reference command ( \ref target "Title") can be used. MyNamespace::AwesomeClass::printįull URLs (with and email addresses are converted into links. Accessing a method of one specific class, the :: and # notation is supported. To force the reference to a class or method one can use the \see command followed by a list of class and method names. In case of function and class names, Doxygen is smart and will automatically create a link to the documentation of a function or class whenever it is mentioned inside Doxygen comments.
0 Comments
Leave a Reply. |