QDoc Manual

ProgressBar

Switch

TabWidget

Adding Tabs

Core Features

Signals and Slots

Introduction

Qt Object Model

Layout Classes

QML Documentation Example

QML Class

Properties, Signals, Handlers, and Methods

Internal Documentation

QML Types with C++ Implementation

QA Pages

Generating the QA Pages

Finding the Module's Main QA Page

Links To Links Page

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

Creating QDoc Configuration Files

QDoc Configuration Files

Project Information

Input and Output Directories

Extra Files

Qt Help Framework Configuration

HTML Configuration

DITA XML Configuration

Qt Index Reference

Macros and Other Configurations

QML Additions

Writing Documentation

QDoc Comments

QDoc Commands

QDoc Topics

Topic Contexts

Documentation Markup

Anatomy of Documentation

Getting Started with QDoc

Chapters

C++ Documentation Style

Class Documentation

The Brief and Detailed Description

Member Functions

Properties

Signals, Notifiers, and Slots

Enums, Namespaces, and Other Types

QML Documentation Style

QML Types

Properties

Signals and Handlers Documentation

Methods and JavaScript Functions

Enumerations

Creating DITA Maps

What is a DITA Map?

\ditamap

\topicref \endtopicref

\mapref

An Example Ditamap Page

The Resulting Ditamap File

Command Index

Context Commands

Document Navigation

Example

Commands

\previouspage

\nextpage

\startpage

\contentspage

\indexpage

Status

\abstract and \qmlabstract

\compat

\default

\obsolete

\internal

\preliminary

\since

Thread Support

Example

Commands

\threadsafe

\reentrant

\nonreentrant

Relating Things

Commands

\inherits

\overload

\reimp

\relates

Grouping Things

Commands

\ingroup

\inmodule

Naming Things

Commands

\title

\subtitle

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

Text Markup

\a (parameter marker)

\c (code font)

\div

\span

\tt (teletype font)

\b

\e (emphasis, italics) (new 5/3/2012)

\sub

\sup

\uicontrol

\underline

\\ (double backslash)

Document Structure

sectionOne-command

sectionTwo-command

sectionThree-command

sectionFour-command

\part

\chapter

\section1

\section2

\section3

\section4

Including Code Inline

\code

\newcode

\oldcode

\qml

Including External Code

\quotefile

\quotefromfile

\printline

\printto

\printuntil

\skipline

\skipto

\skipuntil

\dots

\snippet

\codeline

Creating Links

\l (link)

Fixing Ambiguous Links

What arguments can appear in square brackets?

\sa (see also)

\target

\keyword

Including Images

\image

\inlineimage

\caption

Tables and Lists

\table

\header

\row

\value

\omitvalue

\list

\li (table cell, list item)

Special Content

brief class

preview window

\quotation

\footnote

\note

\tableofcontents

\brief

\legalese

\warning

Miscellaneous

table example

list example

\annotatedlist

\generatelist

annotatedclasses

annotatedexamples

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

classesbymodule

qmltypesbymodule

jstypesbymodule

compatclasses

functionindex

legalese

overviews

related

\if

\endif

\else

\include

\include filename snippet-identifier

\meta

\noautolist

\omit

\raw (avoid)

\unicode

The QDoc Configuration File

General Description

Configuration Variables

Variable List

Categories

Configuration File Examples

minimum.qdocconf

qtgui.qdocconf

Generating DITA XML Output

Creating Help Project Files

Overview

Using Selectors

Adding Table of Contents

Generic Configuration Variables

examples.fileextensions-variable

headers.fileextensions-variable

images.fileextensions-variable

sources.fileextensions-variable

alias

codeindent

codeprefix, codesuffix

defines

edition

exampledirs

examples

examples.fileextensions

excludedirs

excludefiles

extraimages

falsehoods

generateindex

headerdirs

headers

headers.fileextensions

imagedirs

images

images.fileextensions

language

macro

manifestmeta

naturallanguage

outputdir

outputencoding

outputformats

outputprefixes

outputsuffixes

qhp

sourcedirs

sourceencoding

sources

sources.fileextensions

spurious

syntaxhighlighting

tabsize

tagfile

version

versionsym

C++ Specific Configuration Variables

Cpp.ignoredirectives-variable

Cpp.ignoretokens-variable

Cpp.ignoredirectives

Cpp.ignoretokens

HTML Specific Configuration Variables

HTML.footer-variable

HTML.postheader-variable

HTML.style-variable

HTML.stylesheets-variable

HTML.tocdepth

HTML.footer

HTML.postheader

HTML.style

HTML.stylesheets

HTML.tocdepth

Supporting Derived Projects

description

indexes

project

url

How to Support Derived Projects

Example Manifest Files

Manifest XML Structure

Manifest Meta Content

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

\typedef

\variable

QDoc Manual

A Minimal qdocconf File

Qtgui.qdocconf with notes

UI Components