When this command is put in a comment block of a function or method and HAVE_DOT is set to YES, then doxygen will generate a call graph for that function (provided the implementation of the function or method calls other documented functions). See also page Grouping, sections \defgroup, \ingroup, and \weakgroup. * Additional documentation for group 'mygrp' The title is optional, so this command can also be used to add a number of entities to an existing group using and like this: /*! \addtogroup mygrp Unrecognized commands are treated as normal text.ĭefines a group just like \defgroup, but in contrast to that command using the same more than once will not result in a warning, but rather one group with a merged documentation and the first title found in any of the commands. The following subsections provide a list of all commands that are recognized by doxygen. Here is an alphabetically sorted list of all commands with references to their documentation: If in addition to the above argument specifiers brackets are used the argument is optional, unless they are placed between quotes in that case they are a mandatory part of the command argument. The starting curly brace has to directly follow the command, so without whitespace. If braces are also used for command options, here the braces are mandatory and just 'normal' characters. If (round) braces are used the argument extends until the end of the line on which the command was found. If braces are used the argument is a single word. Some commands have one or more arguments.
Note: In the current version, is not working as expected, so it is to be avoided.All commands in the documentation start with a backslash ( \) or an at-sign ( If you prefer you can replace all commands starting with a backslash below by their counterparts that start with an at-sign. It is recommended to repeat the name in the closing brace, as seen below.įor readability, use an empty line after opening braces and before closing braces. Groups have names and descriptions (be sure the comments are continuous up to the opening brace). Use of to define custom member groupingįor a better look, it is recommended to group class definitions based on their logic, instead of the default class visibility grouping. The comment block should be continuous to the object comments, otherwise the header file definition is not attached to the object. The first name should be present in the filesystem, so it might need some prefixing.
* Interrupt numbers defined by the Cortex-M0 light architecture. * ARM Cortex-M architecture interrupt numbers base
* CoreInterruptNumbers.h "hal/architecture/arm/cortexm/include/CoreInterruptNumbers.h" For visibility reasons, add empty lines inside the comment block. When including lines of code, surround them by and add the language. Back apostrophes for references to codeĪlways use `something` instead of something, or something, or something. cpp file with the method/functions definitions.Īlways add the and commands in the header file before the member declaration, and the detailed part of the documentation before the member definition (be it in. */ Use with declarations and with definitionsĬontrary to Java, the C++ sources are usually split between a. * The trace_streambuf_base class implements an ostream class
0 kommentar(er)
