Miscellaneous Macros

You can use the following macros to affect the HTML output and to use standard terminology:

• \borderedimage
• \examplecategory
• \key
• \nullptr
• \summary

\borderedimage

Like \image, but adds a border around the image.

\examplecategory

Describes the category an example is sorted to in the Qt Creator Examples tab.

\key

Formats keyboard key names.

\nullptr

Expands to the term to use for null pointers.

\summary

Like \brief, but replicates the sentence also as text.

Wrap the entire sentence within {}. For example:

\summary {Creates a build target.}