Context Commands | QDoc Manual 5.9

Qt 5.9 | QDoc Manual | Context Commands

Qt 5.9.4 Reference Documentation

Topic Commands ◦ Document Navigation

# 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 ?

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
- \compat,
- \contentspage,
- \indexpage,
- \ingroup,
- \inherits,
- \inmodule,
- \internal,
- \nextpage,
- \nonreentrant,
- \obsolete,
- \overload,
- \preliminary,
- \previouspage,
- \qmlabstract
- \reentrant,
- \reimp,
- \relates,
- \since,
- \startpage,
- \subtitle
- \threadsafe,
- \title

Topic Commands ◦ Document Navigation