Context Commands
The context commands provide information about the element being documented that QDoc can't deduce on its own. For example:
- Is this class thread-safe?
- Is this function reentrant?
- Of which module is this class a member?
- Which include statement is needed to use this class?
Context commands can appear anywhere in a QDoc comment, but they are normally placed near the top of the comment, just below the topic command.
- \abstract
- \ingroup,
- \inheaderfile,
- \inherits,
- \inmodule,
- \internal,
- \nextpage,
- \nonreentrant,
- \obsolete,
- \overload,
- \preliminary,
- \previouspage,
- \qmlabstract
- \qtcmakepackage
- \readonly
- \reentrant,
- \reimp,
- \relates,
- \required
- \since,
- \startpage,
- \subtitle
- \threadsafe,
- \title
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.0/14-qdoc-commands-contextcommands.html