QDoc Manual

C++ Documentation Style

Class Documentation

The Brief and Detailed Description

Member Functions

Properties

Signals, Notifiers, and Slots

Enums, Namespaces, and Other Types

CMake Text Snippets

Categories of Documentation

API Documentation

Language Styles

Documenting QML Types

QML Parser

QML Modules

Read-only and Internal QML Properties

Articles & Overviews

Tutorials, How-To's, FAQ's

Code Examples

Command Index

Context Commands

Creating Help Project Files

Overview

Using Selectors

Adding Table of Contents

Creating Links

\l (link)

Fixing Ambiguous Links

What arguments can appear in square brackets?

\sa (see also)

\target

\target in a \table

\keyword

Creating QDoc Configuration Files

QDoc Configuration Files

Project Information

Input and Output Directories

Extra Files

Qt Help Framework Configuration

HTML Configuration

QDoc Index Files

Macros and Other Configurations

QML Additions

Document Navigation

Example

Commands

\previouspage

\nextpage

\startpage

Document Structure

sectionOne-command

sectionTwo-command

sectionThree-command

sectionFour-command

Section commands

\section1

\section2

\section3

\section4

Example Manifest Files

Manifest XML Structure

Manifest Meta Content

Format-specific Configuration Variables

HTML.footer-variable

FORMAT.nosubdirs

FORMAT.outputsubdir

HTML.postheader-variable

FORMAT.quotinginformation

HTML.style-variable

HTML.stylesheets-variable

HTML.tocdepth

HTML Specific Configuration Variables

HTML.footer

<FORMAT>.nosubdirs

<FORMAT>.outputsubdir

HTML.postheader

<FORMAT>.quotinginformation

HTML.style

HTML.stylesheets

<FORMAT>.tocdepth

Generic Configuration Variables

examples.fileextensions-variable

headers.fileextensions-variable

sources.fileextensions-variable

codeindent

codeprefix, codesuffix

defines

depends

exampledirs

examples

examplesinstallpath

examples.fileextensions

excludedirs

excludefiles

extraimages

falsehoods

generateindex

headerdirs

headers

headers.fileextensions

includepaths

ignorewords

ignoresince

imagedirs

language

locationinfo

macro

manifestmeta

moduleheader

naturallanguage

navigation

outputdir

outputencoding

outputformats

outputprefixes

outputsuffixes

qhp

sourcedirs

sourceencoding

sources

sources.fileextensions

spurious

syntaxhighlighting

tabsize

tagfile

version

versionsym

warninglimit

Getting Started with QDoc

Chapters

Grouping Things

Commands

\ingroup

\inmodule

HTML and DocBook Formatting

How to Resolve QDoc Warnings

Can't link to <target>

Found a \target command outside table item in a table

Cannot find snippets file to quote from

Unexpected \snippet

Undocumented QML <module> referred by <type> or its members

No such <type> in QML <module>

Undocumented return value

Undocumented parameter

No such parameter

Unknown macro

Failed to find function when parsing \fn <signature>

QML type <TypeName> documented with <ClassName> as its native type. Replacing <ClassName> with <OtherClass>

Cannot tie this documentation to anything

This qdoc comment contains no topic command (e.g., \module, \page)

<name> documented more than once

Namespace <name> documented more than once

<name> is documented, but namespace <namespace> is not documented in any module

Has no \inmodule command

Cannot find <name> specified with \<command> in any header file

Unrecognizable QML module/type qualifier for <identifier>

Missing property type for <name>

QML property documented multiple times: <identifier>

Command <command> not allowed with QML property commands

Cannot find base function for <method> in <class>

Illegal \reimp; no documented virtual function for <command>

<class> tries to inherit itself

\nativetype is only allowed in \qmltype

All properties in a group must belong to the same type: <name>

Cannot find project file for example <name>

Cannot open file to quote from: <filename>

Missing format name after \raw

Macro cannot have both format-specific and qdoc-syntax definitions

Unknown command <name>

Duplicate target name <target>

Cannot find qdoc include file <filename>

Cannot find <tag> in <file>

Empty qdoc snippet <tag> in <file>

Cannot nest <command> commands

Missing <outer> before <inner>

Unexpected <end_command>

Missing comma in \sa

Macro <command> does not have a default definition

Macro <macro> invoked with too few arguments (expected <many>, got <few>)

Unbalanced parentheses in <text>

No documentation for <name>

No such enum item <name> in <class>

Undocumented enum item <enum> in <enum list>

Failed to find qhp.<project>.subprojects.<subproject>.indexTitle

\generatelist <group> is empty

\generatelist <group> no such group

Missing image: <imagefile>

Can't link to <target>

Could not resolve QML import statement for type <name>

\brief statement does not end with a full stop

QtDeclarative not installed; cannot parse QML

Invalid regular expression <regex>

Multiple index files found for dependency <indexfile>:<depend>

Cannot locate index file for dependency <depend>

Dependent modules specified, but no index directories were set.

Overrides a previous doc

Unrecognized list style <name>

Unable to parse QML snippet: <code> at line <y>, column <x>

Command <command> failed at end of file <filename>

Failed to open <file> for writing

This page title exists in more than one file

The content is too long

No documentation generated for function <name> in global scope

Documentation configuration for <project> doesn't define a help project (qhp)

Already generated FILE for this project

Invalid QML property type

Including Code Inline

\code

Highlighting and autolinking

Code snippet parameters

Including code from external files

\badcode

\qml

Including External Code

\quotefile

\quotefromfile

\printline

\printto

\printuntil

\skipline

\skipto

\skipuntil

\dots

\snippet

\codeline

Including Images

\image

\inlineimage

\caption

Installing Clang for QDoc

Introduction to QDoc

Running QDoc

Running QDoc in Single Execution Mode

Why Standard Mode Is Slow

Why Single Execution Mode Is Much Faster

How QDoc Works

Command Types

Macros

Global Macros

Adding Macros

Using Macros

Obsolete Macros

Markup Commands

Miscellaneous

table example

list example

\annotatedlist

\qtcmakepackage

\qtcmaketargetitem

\generatelist

<@op>&lt;</@op>group<@op>-</@op>name<@op>&gt;</@op>

Sorting group members

Sort key

annotatedclasses

annotatedexamples

annotatedattributions

classes <@op>&lt;</@op>prefix<@op>&gt;</@op>

classesbymodule

qmltypesbymodule

qmlvaluetypesbymodule

functionindex

legalese

overviews

attributions

related

\if

\endif

\else

\include

\include filename snippet-identifier

Extra arguments

\meta

\noautolist

\omit

\raw (avoid!)

\sincelist

\unicode

Miscellaneous Macros

\borderedimage

\examplecategory

\key

\nullptr

\summary

Naming Things

Commands

\title

\subtitle

Product Names

Product Versions

\techpreview

QDoc Manual

QML Documentation Style

QML Types

Properties

Signals and Handlers Documentation

Methods and QML Functions

Enumerations

Qtgui.qdocconf with notes

Relating Things

Commands

\inherits

\overload

\reimp

\relates

Special Content

\quotation

\note

\tableofcontents

\brief

\legalese

\warning

Status

\abstract and \qmlabstract

\attribution

\default

\compares

\compareswith

\qmldefault

\qmlenumeratorsfrom

\dontdocument

\inheaderfile

\obsolete

\deprecated

\internal

\modulestate

\preliminary

\readonly

\required

\since

Inheritance of Since Information

Since Clause

\wrapper

Supporting Derived Projects

url.examples-variable

description

indexes

project

url

url.examples

How to Support Derived Projects

Tabbed Content

Using Tab Macros

\tab

\tabcontent

\endtabcontent

Tables and Lists

\table

\header

\row

\value

\omitvalue

\list

\li (table cell, list item)

Text Markup

\a (parameter marker)

\c (code font)

\details (collapsible)

\div

\span

\tm (trademark)

\tt (teletype font)

\b

\br

\e (emphasis, italics)

\sub

\sup

\uicontrol

\underline

\\ (double backslash)

-- (en dash)

--- (em dash)

The QDoc Configuration File

General Description

Expansion of Configuration Values

Expanding Environment Variables

Configuration Variables

Variable List

Categories

Configuration File Examples

Thread Support

Example

Commands

\threadsafe

\reentrant

\nonreentrant

Topic Commands

topic argument

Nomenclature for files generated by topic commands

Prefixes and Suffixes for generated files

\class

\enum

\example

\externalpage

\fn (function)

\group

\headerfile

\macro

\module

\namespace

\page

\property

\qmlattachedproperty

\qmlattachedsignal

\qmlvaluetype

\qmlclass

\qmlmethod

\qmltype

\qmlproperty

\qmlsignal

\qmlmodule

\inqmlmodule

\instantiates

\nativetype

\typealias

\typedef

\variable

Writing Documentation

QDoc Comments

QDoc Commands

QDoc Topics

Topic Contexts

Documentation Markup

Anatomy of Documentation

\youtube

minimum.qdocconf

qtgui.qdocconf