These commands provide miscellaneous functions connected to the visual appearance of the documentation, and to the process of generating the documentation.
The \annotatedlist command expands to a list of the members of a group, each member listed with its brief text. Below is an example from the Qt Reference Documentation:
/ *! ... \section1 Drag and Drop Classes These classes deal with drag and drop and the necessary mime type encoding and decoding. \annotatedlist draganddrop * /
This generates a list of all the C++ classes and/or QML types in the draganddrop group. A C++ class or QML type in the draganddrop group will have \ingroup draganddrop in its \class or \qmltype comment.
Use the \qtcmakepackage command to add CMake package information to classes and namespaces. This information will then appear in a table at the top of the class or namespace documentation page. For example:
/*!
\namespace Foo
\inheaderfile Bar
\qtcmakepackage Baz
\brief A namespace.
...
*/
QDoc will output this as
Foo Namespace
A namespace. More...
Header: #include <Bar> CMake: find_package(Qt6 REQUIRED COMPONENTS Baz)
The \generatelist command expands to a list of links to the documentation entities in a group. Below is an example from the Qt Reference Documentation:
/ *! \page classes.html \title All Classes For a shorter list that only includes the most frequently used classes, see \l{Qt's Main Classes}. \generatelist classes Q * /
This generates the All Classes page. The command accepts the following arguments:
annotatedclassesThe annotatedclasses argument provides a table containing the names of all the classes, and a description of each class. Each class name is a link to the class's reference documentation. For example:
| QDial | Rounded range control (like a speedometer or potentiometer) |
| QDialog | The base class of dialog windows |
| QDir | Access to directory structures and their contents |
A C++ class is documented with the \class command. The annotation for the class is taken from the argument of the class comment's \brief command.
annotatedexamplesThe annotatedexamples argument provides a complete list of all examples as a set of tables containing the titles of all the examples, and a description of each example. Each title is a link to the example's
documentation.
A separate table for each module (that has documented examples) is generated, provided that the module has defined a navigation.landingpage configuration variable. The landingpage variable is used as a title for a header that precedes each table.
annotatedattributionsThe annotatedattributions argument provides a complete list of all attributions as a set of tables containing the titles of all the attributions, and a description of each attribution. Each title is a link to
the attribution's page.
A separate table for each module (that has attributions) is generated, provided that the module has defined a navigation.landingpage configuration variable. The landingpage variable is used as a title for a header that precedes each table.
classes <prefix>The classes argument provides a complete alphabetical list of the classes. The second argument, <prefix>, is the common prefix for the class names. The class names will be sorted on the
character that follows the common prefix. e.g. The common prefix for the Qt classes is Q. The common prefix argument is optional. If no common prefix is provided, the class names will be sorted on their first
character.
Each class name becomes a link to the class's reference documentation. This command is used to generate the All Classes page this way:
/ *! \page classes.html \title All Classes \ingroup classlists \brief Alphabetical list of classes. This is a list of all Qt classes. For classes that have been deprecated, see the \l{Obsolete Classes} list. \generatelist classes Q * /
A C++ class is documented with the \class command.
classesbymoduleWhen this argument is used, a second argument is required, which specifies the module whose classes are to be listed. QDoc generates a table containing those classes. Each class is listed with the text of its \brief command.
For example, this command can be used on a module page as follows:
/ *! \page phonon-module.html \module Phonon \title Phonon Module \ingroup modules \brief Contains namespaces and classes for multimedia functionality. \generatelist{classesbymodule Phonon} ... * /
Each class that is a member of the specified module must be marked with the \inmodule command in its \class comment.
qmltypesbymoduleSimilar to classesbymodule argument, but used for listing the QML types from the QML module specified with the second argument.
Note: Support for this argument was introduced in QDoc 5.6.
jstypesbymoduleSimilar to classesbymodule argument, but used for listing the JavaScript types from the module specified with the second argument.
Note: Support for this argument was introduced in QDoc 5.6.
examplefiles [regular_expression]The examplefiles argument lists the files that are part of an example project. The optional second argument is a regular expression; if provided, only the files whose path matches with the regular expression are
listed.
The examplefiles argument can be only used within example documentation (see \example), and is typically used together with the \noautolist command.
exampleimages [regular_expression]The exampleimages argument lists the images that are part of an example project. The optional second argument is a regular expression; if provided, only the image files whose path matches with the regular
expression are listed.
The exampleimages argument can be only used within example documentation (see \example), and is typically used together with the \noautolist command.
functionindexThe functionindex argument provides a complete alphabetical list of all the documented member functions. It is normally used only to generate the Qt function index page this way:
/ *! \page functions.html \title All Functions \ingroup funclists \brief All documented Qt functions listed alphabetically with a link to where each one is declared. This is the list of all documented member functions and global functions in the Qt API. Each function has a link to the class or header file where it is declared and documented. \generatelist functionindex * /
legaleseThe legalese argument tells QDoc to generate a list of licenses in the current documentation project. Each license is identified using the \legalese command.
overviewsThe overviews argument is used to tell QDoc to generate a list by concatenating the contents of all the \group pages. Qt uses it to generate the
overviews page this way:
/ *! \page overviews.html \title All Overviews and HOWTOs \generatelist overviews * /
attributionsThe attributions argument is used to tell QDoc to generate a list of attributions in the documentation.
relatedThe related argument is used in combination with the \group and \ingroup commands to
list all the overviews related to a specified group. For example, the page for the Programming with Qt page is generated this way:
/ *! \group qt-basic-concepts \title Programming with Qt \brief The basic architecture of the Qt cross-platform application and UI framework. Qt is a cross-platform application and UI framework for writing web-enabled applications for desktop, mobile, and embedded operating systems. This page contains links to articles and overviews explaining key components and techniuqes used in Qt development. \generatelist {related} * /
Each page listed on this group page contains the command:
\ingroup qt-basic-concepts
The \if command and the corresponding \endif command enclose parts of a QDoc comment that only will be included if the condition specified by the command's argument is true.
The command reads the rest of the line and parses it as an C++ #if statement.
/ *! \if defined(opensourceedition) \note This edition is for the development of \l{Qt Open Source Edition} {Free and Open Source} software only; see \l{Qt Commercial Editions}. \endif * /
This QDoc comment will only be rendered if the opensourceedition preprocessor symbol is defined, and specified in the defines
variable in the configuration file to make QDoc process the code within #ifdef and #endif:
defines = opensourceedition
You can also define the preprocessor symbol manually on the command line. For more information see the documentation of the defines variable.
See also \endif, \else, defines and falsehoods.
The \endif command and the corresponding \if command enclose parts of a QDoc comment that will be included if the condition specified by the \if command's argument is true.
For more information, see the documentation of the \if command.
See also \if, \else, defines and falsehoods.
The \else command specifies an alternative if the condition in the \if command is false.
The \else command can only be used within \if...\endif commands, but is useful when there is only two alternatives.
The \include command sends all or part of the file specified by its first argument to the QDoc input stream to be processed as a QDoc comment snippet.
The command is useful when some snippet of commands or text is to be used in multiple places in the documentation. Use the \include command wherever you want to insert a snippet into the documentation. The file containing
the snippet to include, must be located under the path(s) listed in the sourcedirs or exampledirs QDoc configuration variable. It can be either any source file parsed by QDoc (or even the same one where \include command is used), or any
other text file. To store snippets in a separate file that is not meant to be parsed by QDoc, use a file extension that is not listed in sources.fileextensions; for example, .qdocinc.
The command can have one or more arguments. The first argument is always a file name. The contents of the file must be QDoc input, in other words, a sequence of QDoc commands and text, but without the enclosing QDoc comment
/*! ... */ delimiters. If you want to include the entire named file, leave the second argument empty. If you want to include only part of the file, see the two argument form below. Here is an example of the one argument form:
/*!
\page corefeatures.html
\title Core Features
\include examples/signalandslots.qdocinc
\include examples/objectmodel.qdocinc
\include examples/layoutmanagement.qdocinc
*/
QDoc renders this page as shown here.
It is a waste of time to make a separate .qdocinc file for every QDoc include snippet you want to use in multiple places in the documentation, especially given that you probably have to put the copyright/license
notice in every one of these files. If you have multiple snippets to be included, you can put them all in a single file and surround each one with:
//! [snippet-id1] QDoc commands and text... //! [snippet-id1] //! [snippet-id2] More QDoc commands and text... //! [snippet-id2]
Then you can use the two-argument form of the command:
\include examples/signalandslots.qdocinc snippet-id2 \include examples/objectmodel.qdocinc another-snippet-id
The sequence of QDoc commands and text found between the two tags with the same name as the second argument is sent to the QDoc input stream. You can even have nested snippets.
Note: Snippet identifiers work also within documentation comment (/*! .. */) blocks, so it's not necessary to use a separate .qdocinc file. When processing a comment block, QDoc removes any
//! comment lines from the generated output.
Since QDoc 6.3, any further arguments passed to the \include command are used for injecting strings into the included content. To inject a string to a specific location in the content, add a backslash followed by a digit (1..9). The digits correspond with the order of the argument list.
For example, given the following snippet in a file includes.qdocinc:
//! [usage]
To enable \e{\1}, select \uicontrol {\2} > \uicontrol Enable.
//! [usage]
Then, the following \include line:
\include includes.qdocinc {usage} {detailed output} {Verbose}
Renders
To enable detailed output, select Verbose > Enable.
Important: Each additional argument (including the snippet ID) must be enclosed in braces. If you want to include the entire file, use an empty snippet ID: {}.
The \meta command is used for adding metadata to example documentation, and when generating HTML output for specifying the maintainer(s) of a C++ class.
The command has two arguments: the first argument is the name of the metadata attribute, and the second argument is the value for the attribute. Each argument should be enclosed in curly brackets, as shown in this example:
/ *! \class QWidget \brief The QWidget class is the base class of all user interface objects. \ingroup basicwidgets \meta {technology} {User Interface} \meta {platform} {macOS 10.6} \meta {platform} {MeeGo} \meta {audience} {user} \meta {audience} {programmer} \meta {audience} {designer} * /
When running QDoc to generate HTML, the example above will have no effect on the generated output.
Example Metadata
Another use for \meta command is to include metadata (tags) in \example documentation. By default, QDoc generates example tags based on the example's \title and module name. These tags are displayed in Qt Creator's Welcome mode, helping users navigate the list of examples.
Additional tags can be created with \meta {tag} {tag1,[tag2,...]}. For example:
/ *!
\example helloworld
\title Hello World Example
\meta {tag} {tutorial,basic}
* /
This would result in the following tags: tutorial,basic,hello,world. Common words such as example are ignored.
Excluding Examples
Marking an example broken will exclude it from the generated manifest file, effectively removing it from Qt Creator's Welcome mode.
\meta tag broken
Example Install Paths
The \meta command combined with an argument installpath specifies the location of an installed example. This value overrides the one that is set using the examplesinstallpath configuration
variable.
/ *!
\example helloworld
\title Hello World Example
\meta {installpath} {tutorials}
* /
See also examplesinstallpath.
The \noautolist command indicates that the annotated list of C++ classes or QML types, which is automatically generated at the bottom of the C++ or QML module page should be omitted, because the classes or types have been listed manually. This command can also be used with the \group command to omit the list of group members, when they are listed manually.
The command must stand on its own line. See Qt Quick Controls QML Types for an example. The page is generated from qtquickcontrols2-qmlmodule.qdoc. There you
will find a QDoc comment containing the \qmlmodule command for the QtQuick.Controls module. The same comment contains a \noautolist command to disable automatic
list generation, and a \generatelist to list the QML types in a specific section of the document.
This command was introduced in QDoc 5.6.
Since Qt 5.10, this command can be applied also to \example documentation, where it causes the automatically generated list of files and images belonging to an example project to be omitted.
The \omit command and the corresponding \endomit command delimit parts of the documentation that you want QDoc to skip. For example:
/ *! \table \row \li Basic Widgets \li Basic GUI widgets such as buttons, comboboxes and scrollbars. \omit \row \li Component Model \li Interfaces and helper classes for the Qt Component Model. \endomit \row \li Database Classes \li Database related classes, e.g. for SQL databases. \endtable * /
QDoc renders this as:
| Basic Widgets | Basic GUI widgets such as buttons, comboboxes and scrollbars. |
| Database Classes | Database related classes, e.g. for SQL databases. |
The \raw command and the corresponding \endraw command delimit a block of raw mark-up language code.
Note: Avoid using this command if possible. If you are trying to generate special table or list behavior, try to get the behavior you want using the \span and \div commands in your \table or \list.
The command takes an argument specifying the code's format. Currently, the only supported format is HTML.
The \raw command is useful if you want some special HTML effects in your documentation.
/ *! Qt has some predefined QColor objects. \raw HTML <style type="text/css" id="colorstyles"> #color-blue { background-color: #0000ff; color: #ffffff } #color-darkBlue { background-color: #000080; color: #ffffff } #color-cyan { background-color: #00ffff; color: #000000 } </style> <p> <tt id="color-blue">Blue(#0000ff)</tt>, <tt id="color-darkBlue">dark blue(#000080)</tt> and <tt id="color-cyan">cyan(#00ffff)</tt>. </p> \endraw * /
QDoc renders this as:
Qt has some predefined QColor objects.
Blue(#0000ff), dark blue(#000080) and cyan(#00ffff).
Note: But you can achieve the exact same thing using QDoc commands. In this case, all you have to do is include the color styles in your style.css file. Then you can write:
\tt {\span {id="color-blue"} {Blue(#0000ff)}},
\tt {\span {id="color-darkBlue"} {dark blue(#000080)}} and
\tt {\span {id="color-cyan"} {cyan(#00ffff)}}.
...which is rendered as:
Blue(#0000ff), dark blue(#000080) and cyan(#00ffff).
The \unicode command allows you to insert an arbitrary Unicode character in the document.
The command takes an argument specifying the character as an integer. By default, base 10 is assumed, unless a '0x' or '0' prefix is specified (for base 16 and 8, respectively). For example:
O G\unicode{0xEA}nio e as Rosas
\unicode 0xC0 table en famille avec 15 \unicode 0x20AC par jour
\unicode 0x3A3 \e{a}\sub{\e{i}}
QDoc renders this as:
O Gênio e as Rosas
À table en famille avec 15 € par jour
Σ ai
