QDoc Manual

A Minimal qdocconf File

C++ Documentation Style

Class Documentation

The Brief and Detailed Description

Member Functions

Properties

Signals, Notifiers, and Slots

Enums, Namespaces, and Other Types

C++ Specific Configuration Variables

Cpp.ignoredirectives-variable

Cpp.ignoretokens-variable

Cpp.ignoredirectives

Cpp.ignoretokens

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

Core Features

Signals and Slots

Introduction

Qt Object Model

Layout Classes

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

\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

images.fileextensions-variable

sources.fileextensions-variable

alias

codeindent

codeprefix, codesuffix

defines

depends

exampledirs

examples

examples.fileextensions

excludedirs

excludefiles

extraimages

falsehoods

generateindex

headerdirs

headers

headers.fileextensions

ignorewords

ignoresince

imagedirs

images

images.fileextensions

language

locationinfo

macro

manifestmeta

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

Including Code Inline

\code

Code snippet parameters

Including code from external files

\badcode

\newcode

\oldcode

\qml

Including External Code

\quotefile

\quotefromfile

\printline

\printto

\printuntil

\skipline

\skipto

\skipuntil

\dots

\snippet

\codeline

Including Images

\image

\inlineimage

\caption

Installing Clang for QDoc

Set Clang location automatically

Specify Clang location manually

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

Markup Commands

Miscellaneous

table example

list example

\annotatedlist

\generatelist

annotatedclasses

annotatedexamples

annotatedattributions

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

classesbymodule

qmltypesbymodule

jstypesbymodule

examplefiles <@op>[</@op>regular_expression<@op>]</@op>

exampleimages <@op>[</@op>regular_expression<@op>]</@op>

functionindex

legalese

overviews

attributions

related

\if

\endif

\else

\include

\include filename snippet-identifier

\meta

\noautolist

\omit

\raw (avoid)

\unicode

Naming Things

Commands

\title

\subtitle

QA Pages

Generating the QA Pages

Finding the Module's Main QA Page

Links To Links Page

QDoc Manual

QML Documentation Style

QML Types

Properties

Signals and Handlers Documentation

Methods and JavaScript Functions

Enumerations

Qtgui.qdocconf with notes

Relating Things

Commands

\inherits

\overload

\reimp

\relates

Special Content

brief class

preview window

\quotation

\footnote

\note

\tableofcontents

\brief

\legalese

\warning

Status

\abstract and \qmlabstract

\default

\dontdocument

\inheaderfile

\obsolete

\internal

\preliminary

\readonly

\since

Supporting Derived Projects

url.examples-variable

description

indexes

project

url

url.examples

How to Support Derived Projects

Tables and Lists

\table

\header

\row

\value

\omitvalue

\list

\li (table cell, list item)

Text Markup

\a (parameter marker)

\c (code font)

\div

\span

\tt (teletype font)

\b

\e (emphasis, italics)

\sub

\sup

\uicontrol

\underline

\\ (double backslash)

The QDoc Configuration File

General Description

Configuration Variables

Variable List

Categories

Configuration File Examples

Thread Support

Example

Commands

\threadsafe

\reentrant

\nonreentrant

Topic Commands

topic argument

preview window

module details

\class

\enum

\example

\externalpage

\fn (function)

\group

\headerfile

\macro

\module

\namespace

\page

\property

\qmlattachedproperty

\qmlattachedsignal

\qmlbasictype

\qmlclass

\qmlmethod

\qmltype

\qmlproperty

\qmlsignal

\qmlmodule

\inqmlmodule

\instantiates

\typealias

\typedef

\variable

Writing Documentation

QDoc Comments

QDoc Commands

QDoc Topics

Topic Contexts

Documentation Markup

Anatomy of Documentation

minimum.qdocconf

qtgui.qdocconf