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
• \compares (Since QDoc 6.7)
• \compareswith (Since QDoc 6.7)
• \default
• \deprecated
• \ingroup
• \inheaderfile
• \inherits
• \inmodule
• \internal
• \modulestate (Since QDoc 6.5)
• \nextpage
• \nonreentrant
• \overload
• \preliminary
• \previouspage
• \qmlabstract
• \qmldefault
• \qtcmakepackage
• \readonly
• \reentrant
• \reimp
• \relates
• \required
• \since
• \startpage
• \subtitle
• \threadsafe
• \title
• \wrapper