| Trolltech | Trolltech |
|---|---|
|
|
|
|
|
| Qt Core Feature | Brief Description |
|---|---|
| Signals and Slots | Signals and slots are used for communication between objects. |
| Layout Management | The Qt layout system provides a simple and powerful way of specifying the layout of child widgets. |
| Drag and Drop | Drag and drop provides a simple visual mechanism which users can use to transfer information between and within applications. |
| This header cell spans three columns but only one row | ||
|---|---|---|
| This table cell spans two columns but only one row | This table cell spans only one column, but two rows. | |
| A regular table cell | A regular table cell | |
| Qt Core Feature | Brief Description |
|---|---|
| Signals and Slots | Signals and slots are used for communication between objects. |
| Qt Core Feature | Brief Description |
|---|---|
| Signals and Slots | Signals and slots are used for communication between objects. |
| Layout Management | The Qt layout system provides a simple and powerful way of specifying the layout of child widgets. |
| Drag and Drop | Drag and drop provides a simple visual mechanism which users can use to transfer information between and within applications. |
| This header cell spans three columns but only one row | ||
|---|---|---|
| This table item spans two columns but only one row | This table item spans only one column, but two rows. | |
| A regular table item | A regular table item | |
Basic Qt
This is the first part.
Getting Started
This is the first part's first chapter.Hello Qt
This is the first chapter's first section.
Making Connections
This is the first chapter's second section.
Using the Reference Documentation
This is the first chapter's third section.
Creating Dialogs
This is the first part's second chapter.
Subclassing QDialog
This is the second chapter's first section.
...Intermediate Qt
This is the second part.
Layout Management
This is the second part's first chapter.
Basic Layouts
This is the first chapter's first section.
... \endraw \endquotation Then \code / *! Contents: \tableofcontents ... * / \endcode will expand to \quotation \raw HTMLContents:
... \endraw \endquotation Each table entry becomes a link to the corresponding part, chapter or section. \row \o \bold \\brief \target brief \o \bold {The \\brief command introduces a one-sentence description of a class, namespace, header file, property or variable.} The brief text is used to introduce the documentation of the associated object, and in lists generated using the \l {generatelist}{\\generatelist} command. The \\brief command can be used in two significant different ways: \l {brief class}{One for classes, namespaces and header files}, and \l {brief property}{one for properties and variables}. \target brief property When the \\brief command is used to describe a property or a variable, the brief text must only be a sentence fragment and start with "whether" (for boolean properties and variables) or "the" (for any other property or variable). For example the boolean QWidget::isWindow property: \code / *! \property QWidget::isActiveWindow \brief whether this widget's window is the active window The active window is the window that contains the widget that has keyboard focus. When popup windows are visible, this property is true for both the active window \e and for the popup. \sa activateWindow(), QApplication::activeWindow() * / \endcode and the QWidget::geometry property \code / *! \property QWidget::geometry \brief the geometry of the widget relative to its parent and excluding the window frame When changing the geometry, the widget, if visible, receives a move event (moveEvent()) and/or a resize event (resizeEvent()) immediately. ... \sa frameGeometry(), rect(), ... * / \endcode The latter will be rendered as \quotation \raw HTMLgeometry : QRect
\endraw This property holds the geometry of the widget relative to its parent and excluding the window frame. ... Access functions: \list \o \bold {const QRect & geometry () const} \o \bold {void setGeometry ( int x, int y, int w, int h )} \o \bold {void setGeometry ( const QRect & )} \endlist See also \l {QWidget::frameGeometry()}{frameGeometry()}, \l {QWidget::rect()}{rect()}, ... \endquotation \target brief class When the \\brief command is used to describe a class, the brief text should be a complete sentence and must start like this: \code ThePreviewWindow Class Reference
\endraw The PreviewWindow class is a custom widget displaying the names of its currently set window flags in a read-only text editor. \l {preview window}{More...} \raw HTMLProperties
\endraw \list \o 52 properties inherited from QWidget \o 1 property inherited from QObject \endlist \raw HTMLPublic Functions
\endraw \list \o \l {constructor}{PreviewWindow}(QWidget *parent = 0) \o void \l {function}{setWindowFlags}(Qt::WindowFlags flags) \endlist \list \o 183 public functions inherited from QWidget \o 28 public functions inherited from QObject \endlist \raw HTMLPublic Slots
\endraw \list \o 17 public slots inherited from QWidget \o 1 public slot inherited from QObject \endlist \raw HTMLAdditional Inherited Members
\endraw \list \o 1 signal inherited from QWidget \o 1 signal inherited from QObject \o 4 static public members inherited from QWidget \o 4 static public members inherited from QObject \o 39 protected functions inherited from QWidget \o 7 protected functions inherited from QObject \endlist \target preview window \raw HTMLDetailed Description
\endraw The PreviewWindow class is a custom widget displaying the names of its currently set window flags in a read-only text editor. The PreviewWindow class inherits QWidget. The widget displays the names of its window flags set with the \l {function}{setWindowFlags()} function. It is also provided with a QPushButton that closes the window. ... See also QWidget. \raw HTMLMember Function Documentation
\endraw \target constructor \raw HTMLPreviewWindow(QWidget *parent = 0)
\endraw Constructs a preview window widget with \i parent. \target function \raw HTMLsetWindowFlags(Qt::WindowFlags flags)
\endraw Sets the widgets flags using the QWidget::setWindowFlags() function. Then runs through the available window flags, creating a text that contains the names of the flags that matches the flags parameter, displaying the text in the widgets text editor. \endquotation Using \\brief with a namespace can for example look like this: \code / *! \namespace Qt \brief The Qt namespace contains miscellaneous identifiers used throughout the Qt library. * / \endcode and finally using \\brief with a header file can look something like this: \code / *! \headerfile| QDial | Rounded range control (like a speedometer or potentiometer) |
| QDialog | The base class of dialog windows |
| QDir | Access to directory structures and their contents |
| A | QAbstractButton | QAbstractExtensionManager | QAbstractItemModel | ||
| QAbstractEventDispatcher | QAbstractFormBuilder | QAbstractItemView | |||
| QAbstractExtensionFactory | QAbstractItemDelegate | QAbstractListModel |
DTDHandler: QXmlReader
QAXCLASS: global
QAXFACTORY_BEGIN: global
QAXFACTORY_DEFAULT: global
QAXFACTORY_END: global
\endraw ... \endquotation \o \c legalese The \c legalese argument provides a complete list of all the licenses. The licenses are identified within the documentation using the \l {legalese}{\\legalese} command. For example: \quotation \raw HTMLCopyright (c) 1989 The Regents of the University of California. All rights reserved.
Redistribution and use in source and binary forms are permitted provided that the above copyright notice and this paragraph are duplicated in all such forms and that any documentation, advertising materials, and other materials related to such distribution and use acknowledge that the software was developed by the University of California, Berkeley...
Copyright (c) 1991 by AT&T.
Permission to use, copy, modify, and distribute this software for any purpose without fee is hereby granted, provided that this entire notice is included in all copies of any software which is or includes a copy or modification of this software and in all copies of the supporting documentation for such software...
\endraw ... \endquotation \o \c mainclasses The \c mainclasses argument provides a complete alphabetical list of the main classes. Each class name is a link to the class's reference documentation. A class is related to the group of main classes by using the \l {mainclass}{\\mainclass} command. The list is rendered similarily to the list generated by the \l {list example}{\c classes} argument. \o \c overviews The \c overviews argument provides a complete alphabetical overview of the documentation. Each list entry is a link to the respective documentation page. The list includes pages declared using commands like \l {page}{\\page} and \l {group}{\\group}. The list omits examples and classes, and only lists the first page of documentation that contains two or more pages using commands like \l {nextpage}{\\nextpage}. For example: \quotation \raw HTML
- <QtAlgorithms> - Generic Algorithms
- <QtGlobal> - Global Qt Declarations
- A standard ActiveX and the "simple" ActiveQt widget
- About Qt
- About Trolltech
- Abstract Widget Classes
- Accessibility Classes ...
Core Features
\endraw \include examples/signalandslots.qdocinc \include examples/objectmodel.qdocinc \include examples/layoutmanagement.qdocinc \endquotation Here is the actual \c .qdocinc files: \l signalandslots.qdocinc, \l objectmodel.qdocinc, \l layoutmanagement.qdocinc \row \o \bold \\meta \target meta \o \bold {The \\meta command is the QDoc equivalent to the HTML \c meta tag.} The command accepts two arguments: The first argument (the following word) is equivalent to the HTML meta tag's \i name variable, and the second argument (the rest of the line) is equivalent to the tag's \i contents variable. For example: \code / *! \meta author Summerfield \section1 Automatic Dialogs \abstract This article shows how to maintain sets of "attributes" (QVariant values), and how to allow users to view and edit them using dialogs that are created dynamically based on the attributes and their types. \endabstract The Attributes class described in this article holds a set of QVariants, and can create a dialog to present the QVariants to the user in an appropriate way. ... * / \endcode will be included in the generated HTML page as \code ... ... \endcode \row \o \bold \\omit \target omit \o \bold {The \\omit command and the correspondning \\endomit command delimit parts of the documentation that you want QDoc to skip.} For example: \code / *! \table \row \o Basic Widgets \o Basic GUI widgets such as buttons, comboboxes and scrollbars. \omit \row \o Component Model \o Interfaces and helper classes for the Qt Component Model. \endomit \row \o Database Classes \o Database related classes, e.g. for SQL databases. \endtable * / \endcode will be rendered as \raw HTML| Basic Widgets | Basic GUI widgets such as buttons, comboboxes and scrollbars. |
| Database Classes | Database related classes, e.g. for SQL databases. |
Blue(#0000ff), dark blue(#000080) and cyan(#00ffff). \endraw * / \endcode will be rendered as \quotation Qt has some predefined QColor objects. For example: \raw HTML
Blue(#0000ff),
dark blue(#000080) and
cyan(#00ffff).
\endraw
\endquotation
\row
\o \bold \\unicode \target unicode
\o \bold {The \\unicode command allows you to insert an
arbitrary Unicode character in the document.}
The command takes an argument specifying the character as
an integer. By default, base 10 is assumed, unless a '0x'
or '0' prefix is specified (for base 16 and 8,
respectively). For example:
\code
O G\unicode{0xEA}nio e as Rosas
\unicode 0xC0 table en famille avec 15 \unicode 0x20AC par jour
\unicode 0x3A3 \i{a}\sub{\i{i}}
\endcode
will be rendered as
\quotation
O G\unicode{0xEA}nio e as Rosas
\unicode 0xC0 table en famille avec 15 \unicode 0x20AC par jour
\unicode 0x3A3 \i{a}\sub{\i{i}}
\endquotation
The \\raw command follows the same conventions as the \l
{i}{\\i} command for \l {argument}{punctuation and use of
braces} for the argument.
\endtable
*/
/*!
\page 12-1-signalandslots.html
\previouspage Miscellaneous Commands
\contentspage QDoc Manual - Table of Contents
\title signalandslots.qdocinc
\quotefile examples/signalandslots.qdocinc
*/
/*!
\page 12-2-objectmodel.html
\previouspage Miscellaneous Commands
\contentspage QDoc Manual - Table of Contents
\title objectmodel.qdocinc
\quotefile examples/objectmodel.qdocinc
*/
/*!
\page 12-3-layoutmanagement.html
\previouspage Miscellaneous Commands
\contentspage QDoc Manual - Table of Contents
\title layoutmanagement.qdocinc
\quotefile examples/layoutmanagement.qdocinc
*/
/*!
\page 13-qdoc-commands-topical.html
\previouspage Miscellaneous Commands
\contentspage QDoc Manual - Table of Contents
\nextpage Contextual Commands
\title Topical Commands
The topical commands tell QDoc what is being documented
(i.e. existing units like classes, functions and examples), and
some of the commands allows you to create extra pages.
\section1 Alphabetical List
\l {13-qdoc-commands-topical.html#class}{\\class},
\l {13-qdoc-commands-topical.html#enum}{\\enum},
\l {13-qdoc-commands-topical.html#example-command}{\\example},
\l {13-qdoc-commands-topical.html#externalpage}{\\externalpage},
\l {13-qdoc-commands-topical.html#fn}{\\fn},
\l {13-qdoc-commands-topical.html#group}{\\group},
\l {13-qdoc-commands-topical.html#headerfile}{\\headerfile},
\l {13-qdoc-commands-topical.html#macro}{\\macro},
\l {13-qdoc-commands-topical.html#module}{\\module},
\l {13-qdoc-commands-topical.html#namespace}{\\namespace},
\l {13-qdoc-commands-topical.html#page}{\\page},
\l {13-qdoc-commands-topical.html#property}{\\property},
\l {13-qdoc-commands-topical.html#service}{\\service},
\l {13-qdoc-commands-topical.html#typedef}{\\typedef},
\l {13-qdoc-commands-topical.html#variable}{\\variable},
\section1 General Description
When QDoc is processing a comment, it will try to connect the
documentation to the source code. For that reason it will first
look for the topical commands. If there is no such command, it
will try to tie the documentation to the immediately following
code. If there is no topical command, and the documentation cannot
be tied to following code, the documentation is simply lost.
\target topical argument
The documented unit's name is passed as the unique argument for
all the topical commands. The argument's naming convention is the
documented unit's complete name. For example:
\code
\enum QComboBox::InsertPolicy
\endcode
Functions is a special case, the argument's naming convention for
the \l {fn}{\\fn} command is that of the function's definition
outside the class definition. For example:
\code
\fn void PreviewWindow::setWindowFlags()
\endcode
A topical command can appear anywhere in a comment, but must stand
alone on its own line. If the argument spans several lines, make
sure that each line (except the last one) is ended with a
backslash. In addition QDoc counts parentheses, which means that
if it encounters a '(' it considers everything until the closing
')' as its argument.
If a topical command is repeated with different arguments, the
same documentation will appear for both the units. For example:
\code
/ *!
\fn void PreviewWindow::setWindowFlags()
\fn void ControllerWindow::setWindowFlags()
Sets the widgets flags using the QWidget::setWindowFlags()
function.
Then runs through the available window flags, creating a text
that contains the names of the flags that matches the flags
parameter, displaying the text in the widgets text editor.
* /
\endcode
The \c PreviewWindow::setWindowFlags() and \c
ControllerWindow::setWindowFlags() functions will get the same
documentation.
\section1 Command Descriptions
\table
\header
\o Command
\o Description
\row
\o \bold \\class \target class
\o \bold {The \\class command tells QDoc that a class is
part of the public API, and lets you enter a detailed
description.}
The command follows \l {topical argument}{the general
topical command convention} for the argument, and supports
nested classes, for example:
\code
/ *!
\class QMap::iterator
\brief The QMap::iterator class provides an STL-style
non-const iterator for QMap and QMultiMap.
QMap features both \l{STL-style iterators} and
\l{Java-style iterators}. The STL-style iterators ...
* /
\endcode
The generated HTML documentation for the specified class is
put in \c This enum type specifies a corner in a rectangle: These classes are used to handle input and output
to and from external devices, processes, files etc. as
well as manipulating files and directories.
The The
PreviewWindow Class Reference
\endraw
The PreviewWindow class is a custom widget displaying
the names of its currently set window flags in a
read-only text editor. \l {preview window}{More...}
\raw HTML
Properties
\endraw
\list
\o 52 properties inherited from QWidget
\o 1 property inherited from QObject
\endlist
\raw HTML
Public Functions
\endraw
\list
\o \l {constructor}{PreviewWindow}(QWidget *parent = 0)
\o void \l {function}{setWindowFlags}(Qt::WindowFlags flags)
\endlist
\list
\o 183 public functions inherited from QWidget
\o 28 public functions inherited from QObject
\endlist
\raw HTML
Public Slots
\endraw
\list
\o 17 public slots inherited from QWidget
\o 1 public slot inherited from QObject
\endlist
\raw HTML
Additional Inherited Members
\endraw
\list
\o 1 signal inherited from QWidget
\o 1 signal inherited from QObject
\o 4 static public members inherited from QWidget
\o 4 static public members inherited from QObject
\o 39 protected functions inherited from QWidget
\o 7 protected functions inherited from QObject
\endlist
\target preview window
\raw HTML
Detailed Description
\endraw
The PreviewWindow class is a custom widget displaying
the names of its currently set window flags in a
read-only text editor.
The PreviewWindow class inherits QWidget. The widget
displays the names of its window flags set with the \l
{function}{setWindowFlags()} function. It is also
provided with a QPushButton that closes the window.
...
See also QWidget.
\raw HTML
Member Function Documentation
\endraw
\target constructor
\raw HTML
PreviewWindow(QWidget *parent = 0)
\endraw
Constructs a preview window widget with \i parent.
\target function
\raw HTML
setWindowFlags(Qt::WindowFlags flags)
\endraw
Sets the widgets flags using the
QWidget::setWindowFlags() function.
Then runs through the available window flags,
creating a text that contains the names of the flags
that matches the flags parameter, displaying
the text in the widgets text editor.
\endquotation
\row
\o \bold \\enum \target enum
\o \bold {The \\enum command allows you to document a C++ enum.}
The command follows \l {topical argument}{the general
topical command convention} for the argument.
The enum items are documented using the \l {value}{\\value}
command. If an item isn't documented, QDoc will emit a
warning. This can be avoided using the \l
{omitvalue}{\\omitvalue} command excluding an item from the
documentation. The enum documentation will be located in
the associated class, header file or namespace
documentation.
For example:
\code
enum Corner {
TopLeftCorner = 0x00000,
TopRightCorner = 0x00001,
BottomLeftCorner = 0x00002,
BottomRightCorner = 0x00003
#if defined(QT3_SUPPORT) && !defined(Q_MOC_RUN)
,TopLeft = TopLeftCorner,
TopRight = TopRightCorner,
BottomLeft = BottomLeftCorner,
BottomRight = BottomRightCorner
#endif
};
\endcode
In case of the Qt::Corner enum,
\code
/ *!
\enum Qt::Corner
This enum type specifies a corner in a rectangle:
\value TopLeftCorner
The top-left corner of the rectangle.
\value TopRightCorner
The top-right corner of the rectangle.
\value BottomLeftCorner
The bottom-left corner of the rectangle.
\value BottomRightCorner
The bottom-right corner of the rectangle.
\omitvalue TopLeft
\omitvalue TopRight
\omitvalue BottomLeft
\omitvalue BottomRight
* /
\endcode
this associated QDoc comment will be rendered as
\quotation
\raw HTML
enum Qt::Corner
\endraw
\endquotation
in qt.html.
See also \l {value}{\\value} and \l {omitvalue}{\\omitvalue}.
\row
\o \bold \\example \target example-command
\o \bold {The \\example command allows you to document an
example.}
The command follows \l {topical argument}{the general
topical command convention} for the argument. In particular
the command's argument is the example's path relative to
the paths listed in the \l exampledirs configuration
variable.
The documentation will be located in \i
{path-to-example}.html, and QDoc will add a list of all the
example files at the top of this documentation page.
For example, if \l exampledirs contain \c
$QTDIR/examples/widgets/imageviewer, then
\code
/ *!
\example widgets/imageviewer
\title ImageViewer Example
\subtitle
The example shows how to combine QLabel and QScrollArea
to display an image.
...
* /
\endcode
will be rendered as
\quotation
\raw HTML
Constant
Value
Description
Qt::TopLeftCorner
0x00000
The top-left corner of the rectangle.
Qt::TopRightCorner
0x00001
The top-right corner of the rectangle.
Qt::BottomLeftCorner
0x00002
The bottom-left corner of the rectangle.
Qt::BottomRightCorner
0x00003
The bottom-right corner of the rectangle.
Image Viewer Example
bool QToolBar::isAreaAllowed(Qt::ToolBarArea area) const
\endraw
Returns true if this toolbar is dockable in the given
\a area; otherwise returns false.
\endquotation
See also \l {overload}{\\overload}.
\row
\o \bold \\group \target group
\o \bold {The \\group command creates a separate page that
lists the classes belonging to the group specified by the
command's argument.}
The command follows \l {topical argument}{the general
topical command convention} for the argument. The \\group
command is typically followed by a \l {title}{\\title}
command and a short introduction to the group. The
generated HTML documentation for the specified group is put
in Input/Output and Networking
\endraw
\endquotation
in io.html.
Note that overviews related to the given group, must be
listed explicitly using the \l
{generatelist}{\\generatelist} command with the \c related
argument. For example:
\code
/ *!
\group architecture
\title Architecture
These documents describe aspects of Qt's architecture
and design, including overviews of core Qt features and
technologies.
\generatelist{related}
* /
\endcode
See also \l {ingroup}{\\ingroup} and \l
{generatelist}{\\generatelist}.
\row
\o \bold \\headerfile \target headerfile
\o \bold {The \\headerfile command allows you to document
global functions, types and macros declared in a header file.}
The command follows \l {topical argument}{the general
topical command convention} for the argument, and the
generated HTML documentation for the specified header file
is put in
QAbstractSocket
The base functionality common to all socket types
QBuffer
QIODevice interface for a QByteArray
QClipboard
Access to the window system clipboard
<QtAlgorithms> -
Generic Algorithms
Functions
\endraw
\target header
\raw HTML
Detailed Description
void Q_ASSERT ( bool test )
\endraw
Prints a warning message containing the source code
file name and line number if \a test is false.
...
See also Q_ASSERT_X(), qFatal() and \l {Debugging
Techniques}.
\endquotation
in qtglobal.html. And
\code
/ *!
\macro Q_PROPERTY(...)
\relates QObject
This macro declares a QObject property. The syntax is:
...
\sa {Qt's Property System}
* /
\endcode
will be rendered as
\quotation
\raw HTML
Q_PROPERTY ( ... )
\endraw
This macro declares a QObject property. The syntax is:
...
See also \l {Qt's Property System}.
\endquotation
in qobject.html. And
\code
/ *!
\macro Q_OBJECT
\relates QObject
The Q_OBJECT macro must appear in the private section
of a class definition that declares its own signals and
slots or that uses other services provided by Qt's
meta-object system.
...
\sa {Meta-Object System}, {Signals and Slots}, {Qt's
Property System}
* /
\endcode
will be rendered as
\quotation
\raw HTML
Q_OBJECT
\endraw
The Q_OBJECT macro must appear in the private section
of a class definition that declares its own signals and
slots or that uses other services provided by Qt's
meta-object system.
...
See also \l {Meta-Object System}, \l {Signals and
Slots} and \l {Qt's Property System}.
\endquotation
in qobject.html.
\row
\o \bold \\module \target module
\o \bold {The \\module creates a separate page that lists the
classes belonging to the module specified by the command's
argument.}
The command follows \l {topical argument}{the general
topical command convention} for the argument.
A class can be related to a module using the \l
{inmodule}{\\inmodule} command.
The \\module command is typically followed by the \l
{title}{\\title} and \l {brief}{\\brief} commands. Each
class is listed with a link to the class reference page and
a brief description based on the classes' \l
{brief}{\\brief} texts.
For example:
\code
/ *!
\module QtNetwork
\title QtNetwork Module
\brief The QtNetwork module offers classes that allow
you to write TCP/IP clients and servers.
The network module provides classes to make network
programming easier and portable. It offers both
high-level classes such as QHttp and QFtp that
implement specific application-level protocols, and
lower-level classes such as QTcpSocket, QTcpServer, and
QUdpSocket.
* /
\endcode
will be rendered as
\quotation
\raw HTML
\endraw
The QtNetwork module offers classes that allow you to
write TCP/IP clients and servers.\l {module
details}{More...}
\raw HTML
QAbstractSocket
The base functionality common to all socket types
QFtp
Implementation of the FTP protocol
...
...
Detailed Description
The QtNetwork module offers classes that allow you to write TCP/IP clients and servers.
The network module provides classes to make network programming easier and portable. It offers both high-level classes such as QHttp and QFtp that implement specific application-level protocols, and lower-level classes such as QTcpSocket, QTcpServer, and QUdpSocket.
\endraw ... \endquotation in qtnetwork.html. See also \l {inmodule}{\\inmodule} \row \o \bold \\namespace \target namespace \o \bold {The \\namespace command allows you to document a C++ namespace.} The command follows \l {topical argument}{the general topical command convention} for the argument. QDoc will generate the same additional links and documentation for all the members of the namespace as it does for \l {framework}{classes}. The documentation for the specified namespace is put inQt Namespace Reference
The Qt namespace contains miscellaneous identifiers used throughout the Qt library. More...
#include <Qt>
Types
- flags Alignment
- ...
\endraw \target name \raw HTML
Detailed Description
The Qt namespace contains miscellaneous identifiers used throughout the Qt library.
\endraw ... \endquotation in qt.html. \row \o \bold \\page \target page \o \bold {The \\page command allows you to create a stand-alone documentation page.} The command follows \l {topical argument}{the general topical command convention} for the argument. The page's title can be set using the \l {title}{\\title} command. For example: \code / *! \page aboutqt.html \title About Qt Qt by Trolltech is a C++ toolkit for cross-platform GUI application development. Qt provides single-source portability across Microsoft Windows, Mac OS X, Linux, and all major commercial Unix variants. (A version of Qt 4 for embedded Linux will be available in August/September 2005.) Qt provides application developers with all the functionality needed to build applications with state-of-the-art graphical user interfaces. Qt is fully object-oriented, easily extensible, and allows true component programming. ... * / \endcode will be rendered in its own HTML file: \l{About Qt}. \row \o \bold {\\externalpage} \target externalpage \o \bold {The \\externalpage command gives a title to an external URL.} The command follows \l {topical argument}{the general topical command convention} for the argument. For example: \code / *! \externalpage http://www.trolltech.com/products/embedded/index.html \title Qtopia Core * / \endcode The QDoc comment above allows you to link to the Qtopia Core webpage by simply linking to the given title. For example: \code / *! The broad scope of the \l {Qtopia Core} API enables it to be used across a wide variety of development projects. * / \endcode will be rendered as \quotation The broad scope of the \l {http://www.trolltech.com/products/embedded/index.html}{Qtopia Core} API enables it to be used across a wide variety of development projects. \endquotation To achieve the same result without using the \\externalpage command, you would have to hard code the adress into your documentation: \code / *! The broad scope of the \l {http://www.trolltech.com/products/embedded/index.html}{Qtopia Core} API enables it to be used across a wide variety of development projects. * / \endcode The \\externalpage command makes it easier to maintain the documentation. If the adress changes, you only need to change the argument of the \\externalpage command. \row \o \bold \\property \target property \o \bold {The \\property command allows you to document a Qt property.} The command follows \l {topical argument}{the general topical command convention} for the argument. A property is defined using the Q_PROPERTY() macro. The macro takes as arguments the property's name and its set, reset and get functions. For example: \code Q_PROPERTY(QString state READ state WRITE setState) \endcode The set, reset and get functions don't need to be documented, documenting the property is sufficient. QDoc will generate a list of the access function that will appear in the property documentation which in turn will be located in the documentation of the class that defines the property. The \\property command is typically accompanied with a \l {brief}{\\brief} command. In the case of a property, the \l {brief}{\\brief} command's argument is a sentence fragment that will be included in a one-sentence description of the property generated by QDoc. The command follows the same rules for the \l {brief property}{description} as the \l {variable}{\\variable} command. For example: \code / *! \property QPushButton::flat \brief whether the border is disabled This property's default is false. * / \endcode will be rendered as \quotation \raw HTMLflat : bool
\endraw This property holds whether the border is disabled. This property's default is false. Access functions: \list \o \bold { bool isFlat () const} \o \bold { void setFlat ( bool )} \endlist \endquotation in qpushbutton.html. And \code / *! \property QWidget::width \brief the width of the widget excluding any window frame See the \l {Window Geometry} documentation for an overview of window geometry. \sa geometry, height, size * / \endcode will be rendered as \quotation \raw HTMLwidth : const int
\endraw This property holds the width of the widget excluding any window frame. See the \l {Window Geometry} documentation for an overview of window geometry. Access functions: \list \o \bold { int width () const} \endlist See also \l{QWidget::geometry}{geometry}, \l{QWidget::height}{height}, and \l{QWidget::size}{size}. \endquotation in qwidget.html. \row \o \bold \\service \target service \o \bold {The \\service command tells QDoc that a class is a service class and specifies its alias, i.e. the associated service's name.} The command takes two arguments, the service class's name and the associated alias. For example: \code / *! \service TimeService Time ... * / class TimeService : public QCopObjectService { ... } \endcode See also \l {class}{\\class} and \l {generatelist}{\\generatelist}. \row \o \bold \\typedef \target typedef \o \bold {The \\typedef command allows you to document a C++ type definition.} The command follows \l {topical argument}{the general topical command convention} for the argument. The documentation will be located in the associated class, header file or namespace documentation. When documenting a global type definition, the \\typedef command must be accompanied with a \l {relates}{\\relates} command. For example: \code / *! \typedef QObjectList \relates QObject Synonym for QListtypedef QObjectList
\endraw Synonym for QListtypedef QtMsgHandler
\endraw This is a typedef for a pointer to a function with the following signature: \raw HTMLvoid myMsgHandler(QtMsgType, const char *);\endraw See also QtMsgType and qInstallMsgHandler(). \endquotation in qtglobal.html. Other type definitions are located in the documentation of the class that defines it, for example: \code / *! \typedef QLinkedList::Iterator Qt-style synonym for QList::iterator. * / \endcode will be rendered as \quotation \raw HTML
typedef QLinkedList::Iterator
\endraw Qt-style synonym for QList::iterator. \endquotation in qlinkedlist.html. \row \o \bold \\variable \target variable \o \bold {The \\variable command allows you to document a member variable or a constant.} The command follows \l {topical argument}{the general topical command convention} for the argument. The \\variable command is typically followed by a \l {brief}{\\brief} command; QDoc will generate the documentation for the variable based on the brief description. The command follows the same rules for the \l {brief property}{description} as the \l {property}{\\property} command. The documentation will be located in the in the associated class, header file or namespace documentation. In case of a member variable: \code / *! \variable QStyleOption::palette \brief the palette that should be used when painting the control * / \endcode will be rendered as \quotation \raw HTMLQPalette QStyleOption::palette
\endraw This variable holds the palette that should be used when painting the control. \endquotation in qstyleoption.html. But you can also use the \\variable command to document constants like for example the \c Type and \c UserType constants in the QTreeWidgetItem class: \code enum { Type = 0, UserType = 1000 }; \endcode Then \code / *! \variable QTreeWidgetItem::Type The default type for tree widget items. \sa UserType, type() * / \endcode and \code / *! \variable QTreeWidgetItem::UserType The minimum value for custom types. Values below UserType are reserved by Qt. \sa Type, type() * / \endcode will be rendered as \quotation \raw HTMLconst int QTreeWidgetItem::Type
\endraw The default type for tree widget items. See also \l {QTreeWidgetItem::UserType}{UserType} and \l {QTreeWidgetItem::type()}{type()}. \raw HTMLconst int QTreeWidgetItem::UserType
\endraw The minimum value for custom types. Values below UserType are reserved by Qt. See also \l {QTreeWidgetItem::Type}{Type} and \l{QTreeWidgetItem::type()}{type()}. \endquotation in qtreewidget.html. \endtable */ /*! \page 14-qdoc-commands-contextualcommands.html \previouspage Topical Commands \contentspage QDoc Manual - Table of Contents \nextpage Navigation Commands \title Contextual Commands The contextual commands provide QDoc with information, that it wouldn't figure out otherwise, about the documented object. For example whether a class is thread-safe or not. These commands can appear anywhere within a QDoc comment. \section1 Alphabetical List \l {16-qdoc-commands-status.html#compat}{\\compat}, \l {15-qdoc-commands-navigation.html#contentspage}{\\contentspage}, \l {15-qdoc-commands-navigation.html#indexpage}{\\indexpage}, \l {19-qdoc-commands-grouping.html#ingroup}{\\ingroup}, \l {19-qdoc-commands-grouping.html#inmodule}{\\inmodule}, \l {16-qdoc-commands-status.html#internal}{\\internal}, \l {19-qdoc-commands-grouping.html#mainclass}{\\mainclass}, \l {15-qdoc-commands-navigation.html#nextpage}{\\nextpage}, \l {17-qdoc-commands-thread.html#nonreentrant}{\\nonreentrant}, \l {16-qdoc-commands-status.html#obsolete}{\\obsolete}, \l {18-qdoc-commands-relating.html#overload}{\\overload}, \l {16-qdoc-commands-status.html#preliminary}{\\preliminary}, \l {15-qdoc-commands-navigation.html#previouspage}{\\previouspage}, \l {17-qdoc-commands-thread.html#reentrant}{\\reentrant}, \l {18-qdoc-commands-relating.html#reimp}{\\reimp}, \l {18-qdoc-commands-relating.html#relates}{\\relates}, \l {15-qdoc-commands-navigation.html#startpage}{\\startpage}, \l {17-qdoc-commands-thread.html#threadsafe}{\\threadsafe}, \l {20-qdoc-commands-title.html#title}{\\title} \section1 Categories \list \o \l {Navigation Commands} \o \l {Status Commands} \o \l {Thread Support Commands} \o \l {Relating Commands} \o \l {Grouping Commands} \o \l {Title Commands} \endlist */ /*! \page 15-qdoc-commands-navigation.html \previouspage Contextual Commands \contentspage QDoc Manual - Table of Contents \nextpage Status Commands \title Navigation Commands The navigation commands allow you to link the pages of a multipage document together. They provide the components of a navigation bar at the top and bottom of the document. They also provide browser and search engine support. \section1 Alphabetical List \l {15-qdoc-commands-navigation.html#contentspage}{\\contentspage}, \l {15-qdoc-commands-navigation.html#indexpage}{\\indexpage}, \l {15-qdoc-commands-navigation.html#nextpage}{\\nextpage}, \l {15-qdoc-commands-navigation.html#previouspage}{\\previouspage}, \l {15-qdoc-commands-navigation.html#startpage}{\\startpage} \section1 General Description The QDoc comments below shows a typical example using the navigation commands. \code / *! \page basicqt.html \contentspage {Basic Qt}{Contents} \nextpage Getting Started \indexpage Index \startpage Basic Qt \title Basic Qt The Qt toolkit is a C++ class library and a set of tools for building multiplatform GUI programs using a "write once, compile anywhere approach". Table of contents: \list \o \l {Getting Started} \o \l {Creating Dialogs} \o \l {Creating Main Windows} \endlist * / / *! \page gettingstarted.html \previouspage Basic Qt \contentspage {Basic Qt}{Contents} \nextpage Creating Dialogs \indexpage Index \startpage Basic Qt \title Getting Started This chapter shows how to combine basic C++ with the functionality provided by Qt to create a few small graphical interface (GUI) applications. * / / *! \page creatingdialogs.html \previouspage Getting Started \contentspage {Basic Qt}{Contents} \indexpage Index \startpage Basic Qt \title Creating Dialogs This chapter will teach you how to create dialog boxes using Qt. * / / *! \page index.html \indexpage Index \startpage Basic Qt \title Index \list \o \l {Basic Qt} \o \l {Creating Dialogs} \o \l {Getting Started} \endlist * / \endcode The second page of this multipage document, "Getting Started", will be rendered as \quotation \raw HTMLJoining QChar::joining () const
\endraw \bold {This function is under development and is subject to change.} Returns information about the joining properties of the character (needed for certain languages such as Arabic). \endquotation And the function's entry in QChar's list of functions will be rendered as \quotation \list \o ... \o Joining \l {http://qt.nokia.com/doc/4.0/qchar.html#Joining-enum} {joining}() const \c (preliminary) \o ... \endlist \endquotation \row \o \bold \\obsolete \target obsolete \o \bold {The \\obsolete command indicates that the referenced function no longer should be used in new code; there is no guarantee for how long it will remain in the library.} The command must stand on its own line. When generating the reference documentation for a class, QDoc will create and link to a separate page documenting its obsolete functions. Usually an equivalent function is provided as an alternative. For example: \code / *! \fn MyClass::MyObsoleteFunction \obsolete Use MyNewFunction() instead. * / \endcode will be rendered as \quotation \raw HTMLObsolete Members for MyClass
\endraw \bold {The following class members are obsolete.} They are provided to keep old source code working. We strongly advise against using them in new code. ... \list \o void MyObsoleteFunction() \c (obsolete) \o ... \endlist \raw HTMLMember Function Documentation
void MyObsoleteFunction ()
Use MyNewFunction() instead.
\endraw ... \endquotation in myclass-obsolete.html \row \o \bold \\compat \target compat \o \bold {The \\compat command indicates that the referenced class or function is part of the support library provided to keep old source code working.} The command must stand on its own line. Usually an equivalent function or class is provided as an alternative. If the command is used within the documentation of a class, the command expands to a warning that the referenced class is part of the support library. The warning is located on top of the associated documentation. For example: \code / *! \class MyQt3SupportClass \compat * / \endcode will be rendered as \quotation \bold {This class is part of the Qt 3 support library.} It is provided to keep old source code working. We strongly advise against using it in new code. See the \l {http://qt.nokia.com/doc/4.0/porting4.html}{Porting Guide} for more information. \endquotation on the top of the MyQt3SupportClass class reference. If the command is used when documenting a function, QDoc will create and link to a separate page documenting Qt 3 support members when generating the reference documentation for the associated class. For example: \code / *! \fn MyClass::MyQt3SupportMemberFunction \compat Use MyNewFunction() instead. * / \endcode will be rendered as \quotation \raw HTMLQt 3 Support Members for MyClass
\endraw \bold {The following class members are part of the Qt 3 support layer.} They are provided to help you port old code to Qt 4. We advise against using them in new code. ... \list \o void MyQt3SupportMemberFunction() \o ... \endlist \raw HTMLMember Function Documentation
void MyQt3SupportMemberFunction ()
Use MyNewFunction() instead.
\endraw ... \endquotation in myclass-qt3.html \row \o \bold \\internal \target internal \o \bold {The \\internal command indicates that the referenced function is not part of the public interface.} The command must stand on its own line. QDoc ignores the documentation as well as the documented item, when generating the associated class reference documenation. For example: \code / *! \internal Tries to find the decimal separator. If it can't find it and the thousand delimiter is != '.' it will try to find a '.'; * / int QDoubleSpinBoxPrivate::findDelimiter (const QString &str, int index) const { int dotindex = str.indexOf(delimiter, index); if (dotindex == -1 && thousand != dot && delimiter != dot) dotindex = str.indexOf(dot, index); return dotindex; } \endcode in qspinbox.cpp, will not be rendered at all. \row \o \bold \\since \target since \o \bold {The \\since command tells in which minor release the associated functionality was added.} For example: \code / *! \since 4.1 Returns an icon for \a standardIcon. ... \sa standardIconImplementation(), standardPixmap() * / QIcon QStyle::standardIcon(StandardPixmap standardIcon, const QStyleOption *option, const QWidget *widget) const { } \endcode will be rendered as \quotation \raw HTMLQIcon QStyle::standardIcon(StandardPixmap standardIcon, const QStyleOption *option, const QWidget *widget) const
\endraw This function was introduced in Qt version 4.1 Returns an icon for \a standardIcon. ... See also \l {QStyle::standardIconImplementation()}{standardIconImplementation()} and \l {QStyle::standardPixmap()}{standardPixmap()}. \endquotation QDoc generates the "Qt" reference from the \l {25-qdoc-configuration-derivedprojects.html#project}{\c project} configuration variable. For that reason this reference will change according to the current documentation project. See also \l {25-qdoc-configuration-derivedprojects.html#project}{\c project}. \endtable */ /*! \page 17-qdoc-commands-thread.html \previouspage Status Commands \contentspage QDoc Manual - Table of Contents \nextpage Relating Commands \title Thread Support Commands The thread support commands specify the level of support for multithreaded programming of a class or function. \section1 Alphabetical List \l {17-qdoc-commands-thread.html#nonreentrant}{\\nonreentrant}, \l {17-qdoc-commands-thread.html#reentrant}{\\reentrant}, \l {17-qdoc-commands-thread.html#threadsafe}{\\threadsafe} \section1 General Description There are three levels of support for multithreaded programming of a class or function: \c threadsafe, \c reentrant and \c nonreentrant. The default is \c nonreentrant which means that the associated class or function cannot be called by multiple threads. \c Reentrant and \c threadsafe are levels primarily used for classes. \c Reentrant means that all the functions in the referenced class can be called simultaneously by multiple threads, provided that each invocation of the functions reference unique data. While \c threadsafe means that all the functions in the referenced class can be called simultaneously by multiple threads even when each invocation references shared data. When a class is declared \c reentrant or \c threadsafe, using the \l {reentrant}{\\reentrant} and \l {threadsafe}{\\threadsafe} commands respectively, functions in the referenced class can be declared \c nonreentrant, using the \l {nonreentrant}{\\nonreentrant} command, excluding the functions from the general view. For example: \code / *! \class QLocale \brief The QLocale class converts between numbers and their string representations in various languages. \reentrant \ingroup i18n \ingroup text \mainclass QLocale is initialized with a language/country pair in its constructor and offers number-to-string and string-to-number conversion functions similar to those in QString. ... * / / *! \nonreentrant Sets the global default locale to \a locale. These values are used when a QLocale object is constructed with no arguments. If this function is not called, the system's locale is used. \warning In a multithreaded application, the default locale should be set at application startup, before any non-GUI threads are created. \sa system() c() * / void QLocale::setDefault(const QLocale &locale) { default_d = locale.d; } \endcode will be rendered as \quotation \raw HTMLQLocale Class Reference
\endraw
The QLocale class converts between numbers and their string
representations in various languages. More...
\code
#include Member Type Documentation
\endraw ... \raw HTMLvoid QLocale::setDefault ( const QLocale & locale )
\endraw Sets the global default locale to locale. These values are used when a QLocale object is constructed with no arguments. If this function is not called, the system's locale is used. \warning In a multithreaded application, the default locale should be set at application startup, before any non-GUI threads are created. \warning This function is not reentrant. See also \l {QLocale::system()}{system()} and \l {QLocale::c()}{c()}. ... \endquotation As shown above, QDoc generates a notification when a class is declared reentrant, and lists the exceptions (the declared nonreentrant functions). A link to the general documentation on \l {threads.html#reentrant}{reentrancy and thread-safety} is included. In addition a warning, "\bold Warning: This function is not reentrant.", is generated in the nonreentrant functions' documentation. QDoc will generate the same notification and warnings when a class is declared threadsafe. For more information see the general documentation on \l {threads.html#reentrant}{reentrancy and thread-safety}. \section1 Command Descriptions \table \header \o Command \o Description \row \o \bold \\threadsafe \target threadsafe \o \bold {The \\threadsafe command indicates that the associated class or function can be called simultaneously by multiple threads even when each invocation references shared data.} The command must stand on its own line. The generated documentation resulting from using the \\threadsafe command is similar to the result of using the \l {reentrant}{\\reentrant} command. For an example, see the \l {General Description} section. See also \l{reentrant}{\\reentrant} and \l{nonreentrant}{\\nonreentrant}. \row \o \bold \\reentrant \target reentrant \o \bold {The \\reentrant command indicates that the associated class or function can be called simultaneously by multiple threads, provided that each invocation of the functions reference unique data.} The command must stand on its own line. For an example, see the \l {General Description} section. See also \l{nonreentrant}{\\nonreentrant} and \l{threadsafe}{\\threadsafe}. \row \o \bold \\nonreentrant \target nonreentrant \o \bold {The \\nonreentrant command indicates that the associated class or function cannot be called by multiple threads.} The command must stand on its own line. For an example, see the \l {General Description} section. See also \l{reentrant}{\\reentrant} and \l{threadsafe}{\\threadsafe}. \endtable */ /*! \page 18-qdoc-commands-relating.html \previouspage Thread Support Commands \contentspage QDoc Manual - Table of Contents \nextpage Grouping Commands \title Relating Commands The relation commands discribe how the documented object relates to its context: Whether it is an overloaded function, a reimplemented function or a global function related to a specified class or header file. \section1 Alphabetical List \l {18-qdoc-commands-relating.html#overload}{\\overload}, \l {18-qdoc-commands-relating.html#reimp}{\\reimp}, \l {18-qdoc-commands-relating.html#relates}{\\relates}, \section1 Command Descriptions \table \header \o Command \o Description \row \o \bold \\overload \target overload \o \bold {The \\overload command indicates that the function is a secondary overload of its name.} The command must stand on its own line. For any overloaded function (except constructors), QDoc expects one primary version of the function and all the the overloads marked with the \bold{\\overload command}. The primary version should be fully documented. Each overload can have whatever extra documentation you want to add for just that overload. From Qt 4.5, you can include the function name plus '()' as a parameter to the \bold{\\overload} command, which will include a standard \i{This function overloads...} line of text with a link to the documentation for the primary version of the function. For example: \code / *! \overload addAction() This convenience function creates a new action with an \a icon and some \a text. The function adds the newly created action to the menu's list of actions, and returns it. \sa QWidget::addAction() * / QAction *QMenu::addAction(const QIcon &icon, const QString &text) { QAction *ret = new QAction(icon, text, this); addAction(ret); return ret; } \endcode will be rendered as \quotation \raw HTMLQAction * QMenu::addAction ( const QIcon & icon, const QString & text )
\endraw This function overloads \l {http://qt.nokia.com/doc/4.0/qwidget.html#addAction}{addAction()} This convenience function creates a new action with an \i icon and some \i text. The function adds the newly created action to the menu's list of actions, and returns it. See also \l {http://qt.nokia.com/doc/4.0/qwidget.html#addAction} {QWidget::addAction}(). \endquotation If you don't include the function name with the \bold{\\overlaod} command, then instead of the "This function overloads..." line with the link to the documentation for the primary version, you get the old standard line: \quotation This is an overloaded member function, provided for convenience. \endquotation. \row \o \bold \\reimp \target reimp \o \bold {The \\reimp command indicates that the referenced function is a reimplementation of a virtual function, where the reimplementation has no effect on the interface.} The command must stand on its own line. QDoc will omit the reimplemented function from the class reference. For example: \code / *! \reimp * / void QToolButton::nextCheckState() { Q_D(QToolButton); if (!d->defaultAction) QAbstractButton::nextCheckState(); else d->defaultAction->trigger(); } \endcode will not be rendered at all; only a link to the inherited QAbstractButton::nextCheckState() will appear in the documentation. \row \o \bold \\relates \target relates \o \bold {The \\relates command attaches the documentation of a global function to that of a related class or header file.} The command's argument is a class name, an the command (and its argument) must stand on its own line. \code / *! \relates QChar Reads a char from the stream \a in into char \a chr. \sa {Format of the QDataStream operators} * / QDataStream &operator>>(QDataStream &in, QChar &chr) { quint16 u; in >> u; chr.unicode() = ushort(u); return in; } \endcode will be rendered with the QChar documentation. \endtable */ /*! \page 19-qdoc-commands-grouping.html \previouspage Relating Commands \contentspage QDoc Manual - Table of Contents \nextpage Title Commands \title Grouping Commands The grouping commands relate classes to defined groups and modules. The groups are used when generating lists of related classes in the documentation, while the modules are elements of Qt's structure. \section1 Alphabetical List \l {19-qdoc-commands-grouping.html#ingroup}{\\ingroup}, \l {19-qdoc-commands-grouping.html#inmodule}{\\inmodule}, \l {19-qdoc-commands-grouping.html#mainclass}{\\mainclass}, \section1 Command Descriptions \table \header \o Command \o Description \row \o \bold \\mainclass \target mainclass \o \bold {The \\mainclass command relates the documented class to a group called mainclasses.} The command must stand on its own line. For example: \code / *! \class QWidget qwidget.h \brief The QWidget class is the base class of all user interface objects. \mainclass ... * / \endcode will ensure that the QWidget class is included in the \c mainclasses group, which means, for example, that the class will appear on the list created by calling the \l {generatelist}{\\generatelist} command with the \c mainclasses argument: \l http://qt.nokia.com/doc/4.0/mainclasses.html See also \l {generatelist}{\\generatelist}. \row \o \bold \\ingroup \target ingroup \o \bold {The \\ingroup command indicates that the given overview or documented class belongs to a certain group of related docmentation.} A class or overview may belong to many groups. The \\ingroup command's argument is a group name, but note that the command considers the rest of the line as part of its argument. Make sure that the group name is followed by a linebreak. For example: \code / *! \class QDir \brief The QDir class provides access to directory structures and their contents. \ingroup io ... * / \endcode will ensure that the QDir class is included in the \c io group, which means, for example, that QDir will appear on the list created by calling the \l {group}{\\group} command with the \c io argument. Note that to list overviews that are related to a given group, you must generate the list exlicitly by using the \l {generatelist}{\\generatelist} command with the \c related argument. See also \l {group}{\\group}. \row \o \bold \\inmodule \target inmodule \o \bold {The \\inmodule command relates the documented class to the module specified by the command's argument.} For the basic classes in Qt, a class's module is determined by its location, i.e. its directory. However, for extensions, like ActiveQt and Qt Designer, a class needs to be related to a module explicitly. The command's argument is a module name, but note that the command considers the rest of the line as part of its argument. Make sure that the module name is followed by a linebreak. For example: \code /*! \class QDesignerTaskMenuExtension \inmodule QtDesigner * / \endcode will ensure that the QDesignerTaskMenuExtension class is included in the \c QtDesigner module, which means, for example, that the class will appear on the list created by calling the \l {generatelist}{\\generatelist} command with the \c {{classesbymodule QtDesigner}} argument. See also \l {module}{\\module} and \l {generatelist}{\\generatelist}. \endtable */ /*! \page 20-qdoc-commands-title.html \previouspage Grouping Commands \contentspage QDoc Manual - Table of Contents \nextpage QDoc Configuration \title Title Commands In general a title command considers everything that follows it until the first line break as its argument. If the title needs to be spanned over several lines, make sure to end each line (except the last one) with a backslash. \section1 Alphabetical List \l {20-qdoc-commands-title.html#title}{\\title}, \l {20-qdoc-commands-title.html#subtitle}{\\subtitle} \section1 Command Descriptions \table \header \o Command \o Description \row \o \bold \\title \target title \o \bold {The \\title command sets the title for a documentation page, or allows you to override it.} For example: \code / *! \page signalandslots.html \title Signals and Slots Signals and slots are used for communication between objects. The signals and slots mechanism is a central feature of Qt and probably the part that differs most from the features provided by other frameworks. ... * / \endcode will be rendered as \quotation \raw HTMLSignal and Slots
\endraw
Signals and slots are used for communication between
objects. The signals and slots mechanism is a central
feature of Qt and probably the part that differs most
from the features provided by other frameworks.
...
\endquotation
See also \l {subtitle}{\\subtitle}.
\row
\o \bold \\subtitle \target subtitle
\o \bold {The \\subtitle command sets a subtitle for a
documentation page.}
For example:
\code
/ *!
\page qtopiacore-overview.html
\title Qtopia Core
\subtitle Qt for Embedded Linux
Qt/Embedded, the embedded Linux port of Qt, is a
complete and self-contained C++ GUI and platform
development tool for Linux-based embedded development.
...
* /
\endcode
will be rendered as
\quotation
\raw HTML
Qtopia Core
Qt for Embedded Linux
\endraw
Qt/Embedded, the embedded Linux port of Qt, is a
complete and self-contained C++ GUI and platform
development tool for Linux-based embedded development.
...
\endquotation
See also \l {title}{\\title}.
\endtable
*/
/*!
\page 21-0-qdoc-configuration.html
\previouspage Title Commands
\contentspage QDoc Manual - Table of Contents
\nextpage General Configuration Variables
\title QDoc Configuration
\tableofcontents
\list
\o \l {Supporting Derived Projects}
\o \l {QDoc Compatibility}
\endlist
When running QDoc to generate the documentation, you must specify
a configuration file on the command line:
\quotation
\bold {/currentdirectory$ qdoc3 my-documentation.qdocconf}
\endquotation
\section1 General Description
The configuration file is a list of entries of entries of the form
\i {"variable = value"}. Using the configuration variables, you
can define where QDoc should find the various source files, images
and examples, where to put generated documentation etc. The
configuration file can also contain directives like \c
include. For an example, see the \l minimum.qdocconf file.
In addition, you can use some particular configuration variables
to make QDoc support derived projects, i.e make the projects, for
example Qt Solutions, contain links to the online Qt
documentation. These variables are documented in the \l
{Supporting Derived projects} section. In this section you can
also find out how to use these variables to support your derived
projects.
If some of the variable keys have the same values, they can be set
at the same time. For example:
\code
{header, source}dirs = kernel
\endcode
is equivalent to
\code
headerdirs = kernel
sourcedirs = kernel
\endcode
A variable's value can be set using either '=' or '+='. The
difference is that '=' overrides any previously set value, while
'+=' only adds the value to the previously set ones.
In general, some of the variables accepts a list of strings as
their value, while others only accept a single string. If you
provide a variable of the latter type with several strings they
will simply be concatenated. The quotes around the value string
are optional. But applying them allows you to use special
characters like '=' and ' \" ' within the string. For example:
\code
HTML.postheader = "Home"
\endcode
If an entry spans many lines, use a backslash at the end of every
line but the last:
\code
sourcedirs = kernel \
tools \
widgets
\endcode
\section1 Configuration Variables
\section2 Alphabetical List
\l {22-qdoc-configuration-generalvariables.html#alias}{alias},
\l {23-qdoc-configuration-cppvariables.html#Cpp.ignoredirectives}
{Cpp.ignoredirectives},
\l {23-qdoc-configuration-cppvariables.html#Cpp.ignoretoken}
{Cpp.ignoretokens},
\l {22-qdoc-configuration-generalvariables.html#definesvariable}{defines},
\l {22-qdoc-configuration-generalvariables.html#edition}{edition},
\l {22-qdoc-configuration-generalvariables.html#exampledirs}{exampledirs},
\l {22-qdoc-configuration-generalvariables.html#examples}{examples},
\l {22-qdoc-configuration-generalvariables.html#examples.fileextensions}
{examples.fileextensions},
\l {22-qdoc-configuration-generalvariables.html#extraimages}{extraimages},
\l {22-qdoc-configuration-generalvariables.html#falsehoods}{falsehoods},
\l {22-qdoc-configuration-generalvariables.html#headerdirs}{headerdirs},
\l {22-qdoc-configuration-generalvariables.html#headers}{headers},
\l {22-qdoc-configuration-generalvariables.html#headers.fileextensions}
{headers.fileextensions},
\l {24-qdoc-configuration-htmlvariables.html#HTML.footer}{HTML.footer},
\l {24-qdoc-configuration-htmlvariables.html#HTML.postheader}
{HTML.postheader},
\l {24-qdoc-configuration-htmlvariables.html#HTML.style}{HTML.style},
\l {22-qdoc-configuration-generalvariables.html#imagedirs}{imagedirs},
\l {22-qdoc-configuration-generalvariables.html#images}{images},
\l {22-qdoc-configuration-generalvariables.html#images.fileextensions}
{images.fileextensions},
\l {22-qdoc-configuration-generalvariables.html#language}{language},
\l {22-qdoc-configuration-generalvariables.html#macro}{macro},
\l {22-qdoc-configuration-generalvariables.html#outputdir}{outputdir},
\l {22-qdoc-configuration-generalvariables.html#outputformats}
{outputformats},
\l {22-qdoc-configuration-generalvariables.html#slow}{slow},
\l {22-qdoc-configuration-generalvariables.html#sourcedirs}{sourcedirs},
\l {22-qdoc-configuration-generalvariables.html#sources}{sources},
\l {22-qdoc-configuration-generalvariables.html#sources.fileextensions}
{sources.fileextensions},
\l {22-qdoc-configuration-generalvariables.html#spurious}{spurious},
\l {22-qdoc-configuration-generalvariables.html#tabsize}{tabsize},
\l {22-qdoc-configuration-generalvariables.html#version}{version},
\l {22-qdoc-configuration-generalvariables.html#versionsym}{versionsym}
\section2 Categories
\list
\o \l {General Configuration Variables}
\o \l {C++ Specific Configuration Variables}
\o \l {HTML Specific Configuration Variables}
\endlist
\section1 Configuration File Examples
\list
\o A minimum configuration file: \l minimum.qdocconf
\o The Qt configuration file: \l qt.qdocconf
\endlist
*/
/*!
\page 21-1-minimum-qdocconf.html
\previouspage QDoc Configuration
\contentspage QDoc Manual - Table of Contents
\title minimum.qdocconf
\quotefile examples/minimum.qdocconf
*/
/*!
\page 21-2-qt-qdocconf.html
\previouspage QDoc Configuration
\contentspage QDoc Manual - Table of Contents
\title qt.qdocconf
\quotefile files/qt.qdocconf
*/
/*!
\page 22-qdoc-configuration-generalvariables.html
\previouspage QDoc Configuration
\contentspage QDoc Manual - Table of Contents
\nextpage Creating Help Project Files
\title General Configuration Variables
With the general QDoc configuration variables, you can define
where QDoc will find the various source files it needs to generate
the documentation, as well as the directory to put the generated
documentation. You can also do some minor manipulation of QDoc
itself, controlling its output and processing behavior.
\section1 Alphabetical List
\l {22-qdoc-configuration-generalvariables.html#alias}{alias},
\l {22-qdoc-configuration-generalvariables.html#codeindent}{codeindent},
\l {22-qdoc-configuration-generalvariables.html#definesvariable}{defines},
\l {22-qdoc-configuration-generalvariables.html#edition}{edition},
\l {22-qdoc-configuration-generalvariables.html#exampledirs}{exampledirs},
\l {22-qdoc-configuration-generalvariables.html#examples}{examples},
\l {22-qdoc-configuration-generalvariables.html#examples.fileextensions}
{examples.fileextensions},
\l {22-qdoc-configuration-generalvariables.html#extraimages}{extraimages},
\l {22-qdoc-configuration-generalvariables.html#falsehoods}{falsehoods},
\l {22-qdoc-configuration-generalvariables.html#generateindex}{generateindex},
\l {22-qdoc-configuration-generalvariables.html#headerdirs}{headerdirs},
\l {22-qdoc-configuration-generalvariables.html#headers}{headers},
\l {22-qdoc-configuration-generalvariables.html#headers.fileextensions}
{headers.fileextensions},
\l {22-qdoc-configuration-generalvariables.html#imagedirs}{imagedirs},
\l {22-qdoc-configuration-generalvariables.html#images}{images},
\l {22-qdoc-configuration-generalvariables.html#images.fileextensions}
{images.fileextensions},
\l {22-qdoc-configuration-generalvariables.html#language}{language},
\l {22-qdoc-configuration-generalvariables.html#macro}{macro},
\l {22-qdoc-configuration-generalvariables.html#outputdir}{outputdir},
\l {22-qdoc-configuration-generalvariables.html#outputformats}
{outputformats},
\l {22-qdoc-configuration-generalvariables.html#slow}{slow},
\l {22-qdoc-configuration-generalvariables.html#sourcedirs}{sourcedirs},
\l {22-qdoc-configuration-generalvariables.html#sources}{sources},
\l {22-qdoc-configuration-generalvariables.html#sources.fileextensions}
{sources.fileextensions},
\l {22-qdoc-configuration-generalvariables.html#spurious}{spurious},
\l {22-qdoc-configuration-generalvariables.html#tabsize}{tabsize},
\l {22-qdoc-configuration-generalvariables.html#tagfile}{tagfile},
\l {22-qdoc-configuration-generalvariables.html#version}{version},
\l {22-qdoc-configuration-generalvariables.html#versionsym}{versionsym}
\section1 Variable Descriptions
\table
\header
\o Variable
\o Description
\row
\o \bold alias \target alias
\o \bold {The \c alias variable renames a QDoc command.}
The general syntax is \tt {alias.\i{original-command-name}
= \i temporary-command-name}.
For example:
\code
alias.i = e
\endcode
renames the built-in command \\i (italics) to \\e.
The \c alias variable is often used for compatibility
reasons; for more information see the \l {QDoc
Compatibility}{compatibility section}.
See also \l macro.
\row
\o \bold codeindent \target codeindent
\o \bold {The \c codeindent variable specifies the level of
indentation that QDoc uses when writing code snippets.}
QDoc originally used a hard-coded value of four spaces for
code indentation to ensure that code snippets could be easily
distinguished from surrounding text. Since we can use
\l{HTML Specific Configuration Variables#HTML.stylesheets}{stylesheets} to
adjust the appearance of certain types of HTML elements, this
level of indentation is not always required.
\row
\o \bold defines \target definesvariable
\o \bold {The \c defines variable specifies the C++ preprocessor
symbols that QDoc will recognize and respond to.}
When a preprocessor symbol is specified using the \c
defines variable, you can also use the \l {if}{\\if}
command to enclose documentation that only will be included
if the preprocessor symbol is defined.
The values of the variable are regular expressions (see
QRegExp for details). By default, no symbol is defined,
meaning that code protected with #ifdef...#endif will be
ignored.
For example:
\code
defines = Q_QDOC \
QT_.*_SUPPORT \
QT_.*_LIB \
QT_COMPAT \
QT3_SUPPORT \
Q_WS_.* \
Q_OS_.* \
Q_BYTE_ORDER \
__cplusplus
\endcode
ensures that QDoc will process the code that requires these
symbols to be defined. For example:
\code
#ifdef Q_WS_WIN
HDC getDC() const;
void releaseDC(HDC) const;
#endif
\endcode
Since the Q_WS_.* regular expression (specified using the
\c defines variable) matches Q_WS_WIN, QDoc will process
the code within #ifdef and #endif in our example.
You can also define preprocessor symbols manually on the
command line using the -D option. For example:
\code
currentdirectory$ qdoc3 -Dconsoleedition qt.qdocconf
\endcode
In this case the -D option ensures that the \c
consoleedition preprocessor symbol is defined when QDoc
processes the source files defined in the qt.qdocconf file.
See also \l falsehoods and \l {if}{\\if}.
\row
\o \bold edition \target edition
\o \bold {The \c edition variable specifies which modules are
included in each edition of a package, and provides QDoc
with information to provide class lists for each edition.}
This feature is mostly used when providing documentation
for Qt packages.
The \c edition variable is always used with a particular
edition name to define the modules for that edition:
\code
edition.Console = QtCore QtNetwork QtSql QtXml
edition.Desktop = QtCore QtGui QtNetwork QtOpenGL QtSql QtXml \
QtDesigner QtAssistant Qt3Support QAxContainer \
QAxServer
edition.DesktopLight = QtCore QtGui Qt3SupportLight
\endcode
In the above examples, the \c Console edition only includes
the contents of four modules. Only the classes from these
modules will be used when the
\l{Miscellaneous Commands#generatelist}{generatelist} command
is used to generate a list of classes for this edition:
\code
\generatelist{classesbyedition Console}
\endcode
\row
\o \bold exampledirs \target exampledirs
\o \bold {The \c exampledirs variable specifies the directories
containing the source code of the example files.}
The \l {examples}{\c examples} and \c exampledirs variables
are used by the \l {quotefromfile}{\\quotefromfile}, \l
{quotefile}{\\quotefile} and \l {example}{\\example}
commands. If both the \l {examples}{\c examples} and \c
exampledirs variables are defined, QDoc will search in
both, first in \l {examples}{\c examples} then in \c
exampledirs.
QDoc will search through the directories in the specified
order, and accept the first matching file it finds. It will
only search in the specified directories, \i not in
subdirectories.
For example:
\code
exampledirs = $QTDIR/doc/src \
$QTDIR/examples \
$QTDIR \
$QTDIR/qmake/examples
examples = $QTDIR/examples/widgets/analogclock/analogclock.cpp
\endcode
When processing
\code
\quotefromfile widgets/calculator/calculator.cpp
\endcode
QDoc will then see if there exists a file called \c
calculator.cpp listed as a value in the \l {examples}{\c
examples} variable. If it doesn't, it will search in the \c
exampledirs variable, and first see if there exists a file
called
\code
$QTDIR/doc/src/widgets/calculator/calculator.cpp
\endcode
If it doesn't, QDoc will continue looking for a file
called
\code
$QTDIR/examples/widgets/calculator/calculator.cpp
\endcode
and so forth.
See also \l examples.
\row
\o \bold examples \target examples
\o \bold {The \c examples variable allows you to specify individual
example files in addition to those located in the directories
specified by the \l {exampledirs}{\c exampledirs} variable.}
The \c examples and \l {exampledirs}{\c exampledirs}
variables are used by the \l
{quotefromfile}{\\quotefromfile}, \l
{quotefile}{\\quotefile} and \l {example}{\\example}
commands. If both the \c examples and \l {exampledirs}{\c
exampledirs} variables are defined, QDoc will search in
both, first in \c examples then in \l {exampledirs}{\c
exampledirs}.
QDoc will search through the values listed for the \c
examples variable, in the specified order, and accept
the first one it finds.
For an extensive example, see the \l {exampledirs}{\c
exampledirs} command. But note that if you know the file is
listed in the \c examples variable, you don't need to
specify its path:
\code
\quotefromfile calculator.cpp
\endcode
See also \l exampledirs.
\row
\o \bold examples.fileextensions \target examples.fileextensions
\o \bold {The \c examples.fileextensions variable specifies the
file extensions that qdoc will look for when collecting example
files for display in the documentation.}
The default extensions are *.cpp, *.h, *.js, *.xq, *.svg, *.xml
and *.ui. However, if
The extensions are given as standard wildcard expressions.
You can add a file extension to the filter using '+='. For
example:
\code
examples.fileextensions += *.qrc
\endcode
See also \l{headers.fileextensions}.
\row
\o \bold extraimages \target extraimages
\o \bold {The \c extraimages variable tells QDoc to incorporate
specific images in the generated documentation.}
QDoc will not recognize images used within HTML (or any
other markup language). If we want the images to be copied
from the directories specified by \l {imagedirs}{\c
imagedirs} (the images in question must be located in these
directories) to the output directory, we must specify the
images using the \c extraimages variable.
The general syntax is \tt {extraimages.\i{format} = \i
image}. The file extension is optional.
For example, in \l qt.qdocconf we use a couple of images
within the HTML.postheader variable which value is pure
HTML. For that reason, these images are specified using the
\c extraimages variable:
\code
extraimages.HTML = qt-logo
\endcode
See also \l images and \l imagedirs.
\row
\o \bold falsehoods \target falsehoods
\o \bold {The \c falsehoods variable defines the truth value of
specified preprocessor symbols as false.}
If this variable is not set for a preprocessor symbol, QDoc
assumes its truth value is true. The exception is '0',
which value always is false.
QDoc will recognize, and is able to evaluate, the following
preprocessor syntax:
\code
#ifdef NOTYET
...
#endif
#if defined (NOTYET)
...
#end if
\endcode
However, faced with unknown syntax like
\code
#if NOTYET
...
#endif
\endcode
QDoc will evaluate it as true by default, \i unless the
preprocessor symbol is specified within the \c falsehoods
variable entry:
\code
falsehoods = NOTYET
\endcode
See also \l defines.
\row
\o \bold generateindex \target generateindex
\o \bold{The \c generateindex variable contains a boolean value that
specifies whether to generate an index file when HTML documentation
is generated.}
By default, an index file is always generated with HTML documentation,
so this variable is typically only used when disabling this feature
(by setting the value to \c false) or when enabling index generation
for the WebXML output (by setting the value to \c true).
\row
\o \bold headerdirs \target headerdirs
\o \bold {The \c headerdirs variable specifies the directories
containing the header files associated with the \c .cpp source
files used in the documentation.}
For example:
\code
headerdirs = $QTDIR/src \
$QTDIR/extensions/activeqt \
$QTDIR/extensions/motif \
$QTDIR/tools/designer/src/lib/extension \
$QTDIR/tools/designer/src/lib/sdk \
$QTDIR/tools/designer/src/lib/uilib
\endcode
When executed, the first QDoc will do is to read through
the headers specified in the \l {headers}{\c headers}
variable, and the ones located in the directories specified
in the \c headerdir variable (including all
subdirectories), building an internal structure of the
classes and their functions.
Then it will read through the sources specified in the \l
{sources}{\c sources}, and the ones located in the
directories specified in the \l {sourcedirs}{\c sourcedirs}
varible (including all subdirectories), merging the
documentation with the structure it retrieved from the
header files.
If both the \c headers and \c headerdirs variables are
defined, QDoc will read through both, first \l {headers}{\c
headers} then \c headerdirs.
In the specified directories, QDoc will only read the files
with the fileextensions specified in the \l
{headers.fileextensions}{\c headers.fileextensions}
variable. The default extensions are *.ch, *.h, *.h++,
*.hh, *.hpp and *.hxx". The files specified by \l
{headers}{\c headers} will be read independent of their
fileextensions.
See also \l headers and \l headers.fileextensions.
\row
\o \bold headers \target headers
\o \bold {The \c headers variable allows you to specify individual
header files in addition to those located in the directories
specified by the \l {headerdirs}{\c headerdirs} variable.}
For example:
\code
headers = $QTDIR/src/gui/widgets/qlineedit.h \
$QTDIR/src/gui/widgets/qpushbutton.h
\endcode
When processing the \c headers variable, QDoc behaves in the
same way as it does when processing the \l {headerdirs}{\c
headerdirs} variable. For more information, see the \l
{headerdirs}{\c headerdirs} variable.
See also \l headerdirs.
\row
\o \bold headers.fileextensions \target headers.fileextensions
\o \bold {The \c headers.fileextensions variable specify the
extension used by the headers.}
When processing the header files specified in the \l
{headerdirs}{\c headerdirs} variable, QDoc will only read
the files with the fileextensions specified in the \c
headers.fileextensions variable. In this way QDoc avoid
spending time reading irrelevant files.
The default extensions are *.ch, *.h, *.h++, *.hh, *.hpp
and *.hxx.
The extensions are given as standard wildcard expressions.
You can add a file extension to the filter using '+='. For
example:
\code
header.fileextensions += *.H
\endcode
\warning The above assignment may not work as described.
See also \l headerdirs.
\row
\o \bold imagedirs \target imagedirs
\o \bold {The \c imagedirs variable specifies the directories
containing the images used in the documentation.}
The \l {images}{\c images} and \c imagedirs variables are
used by the \l {image}{\\image} and \l
{inlineimage}{\\inlineimage} commands. If both the \l
{images}{\c images} and \c imagedirs variables are defined,
QDoc will search in both, first in \l {images}{\c images}
then in \c imagedirs.
QDoc will search through the directories in the specified
order, and accept the first matching file it finds. It will
only search in the specified directories, \i not in
subdirectories.
For example:
\code
imagedirs = $QTDIR/doc/src/images \
$QTDIR/examples
images = $QTDIR/doc/src/images/calculator-example.png
\endcode
When processing
\code
\image calculator-example.png
\endcode
QDoc will then see if there exists a file called
calculator-example.png listed as a value in the \c images
variable. If it doesn't, it will search in the \c imagedirs
variable, and first see if there exists a file called
\code
$QTDIR/doc/src/images/calculator-example.png
\endcode
If it doesn't, QDoc will look for a file called
\code
$QTDIR/examples/calculator-example.png
\endcode
You can filter the images in an image directory using the
\l {images.fileextensions}{\c images.fileextensions}
variable. The general idea behind the \l
{images.fileextensions}{\c images.fileextensions} variable
is to enable different image format for different output
format.
\warning The \l {images.fileextensions}{\c
images.fileextensions} variable's functionality is
preliminay since QDoc at this point only support HTML.
See also \l images and \l images.fileextensions.
\row
\o \bold images \target images
\o \bold {The \c images variable allows you to specify individual
image files in addition to those located in the directories
specified by the \l {imagedirs}{\c imagedirs} variable.}
For example:
\code
images = $QTDIR/doc/src/images/calculator-example.png
\endcode
When processing the \c images variable, QDoc behaves in the
same way as it does when processing the \l {imagedirs}{\c
imagedirs} variable. For more information, see the \l
{imagedirs}{\c imagedirs} variable.
See also \l imagedirs and \l images.fileextensions.
\row
\o \bold images.fileextensions \target images.fileextensions
\o \bold {The images.fileextensions variable filters the files within
an image directory.}
The variable's values (the extensions) are given as
standard wildcard expressions. The general syntax is: \tt
{images.fileextensions.\i{format} = *.\i{extension}}.
The idea is to enable different image format for different
output format. For example:
\code
images.fileextensions.HTML = *.png
images.fileextensions.LOUT = *.eps
\endcode
Then, when processing the \l {image}{\\image} and \l
{inlineimage}{\\inlineimage} commands, QDoc will only
search for files with extensions specified in the output
format's associated image extension variable.
\warning This is preliminary functionality since QDoc at
this point only support HTML.
The default extensions for HTML are *.png, *.jpg, *.jpeg
and *.gif.
You can add a file extension to the filter using '+='. For
example:
\code
images.fileextensions.HTML += *.eps
\endcode
See also \l imagedirs and \l images.
\row
\o \bold language \target language
\o \bold {The \c language variable specifies the language of the
source code that is used in the documentation.}
Currently, C++ is the only language that QDoc
understands. It is also the default language, and doesn't
really need to be specified. But for example in \l
qt.qdocconf:
\code
language = Cpp
\endcode
identifies the language of the Qt source code as C++.
\row
\o \bold macro \target macro
\o \bold {The \c macro variable can be used to create your
own QDoc commands.}
The general syntax is \tt {macro.\i{command} =
"\i{definition}}". The definition can be described using
QDoc syntax. In addition it is possible to provide an HTML
definition by appending .HTML to the variable.
For example in \l qt.qdocconf:
\code
macro.gui = "\\bold"
macro.raisedaster.HTML = "*"
\endcode
makes sure that the \\gui command renders its argument using a
bold font, and that \\raisedaster renders a '*'.
\row
\o \bold naturallanguage \target naturallanguage
\o \bold {The \c naturallanguage variable specifies the natural
language used for the documentation generated by qdoc.}
For example:
\code
naturallanguage = zh-Hans
\endcode
By default, the natural language is \c en for compatibility
with legacy documentation.
qdoc will add the natural language information to the HTML
it generates, using the \c lang and \c xml:lang attributes.
See also \l sourceencoding, \l outputencoding,
\l{http://www.w3.org/TR/xhtml1/#C_7}{C.7. The lang and xml:lang Attributes} and
\l{http://www.w3.org/TR/i18n-html-tech-lang/#ri20040429.113217290}{Best Practice 13: Using Hans and Hant codes}.
\row
\o \bold outputdir \target outputdir
\o \bold {The \c outputdir variable specifies the directory
where QDoc will put the generated documentation.}
In qt.qdocconf:
\code
outputdir = $QTDIR/doc/html
\endcode
locates the generated Qt reference documentation in
$QTDIR/doc/html. For example, the documentation of the
QWidget class is located in
\code
$QTDIR/doc/html/qwidget.html
\endcode
The associated images will be put in an \c images subdirectory.
\warning When running QDoc multiple times using the same output
directory, all files from the previous run will be lost.
\row
\o \bold outputencoding \target outputencoding
\o \bold {The \c outputencoding variable specifies the encoding
used for the documentation generated by qdoc.}
For example:
\code
outputencoding = UTF-8
\endcode
By default, the output encoding is \c ISO-8859-1 (Latin1) for
compatibility with legacy documentation. When generating
documentation for some languages, particularly non-European
languages, this is not sufficient and an encoding such as UTF-8
is required.
qdoc will encode HTML using this encoding and generate the
correct declarations to indicate to browsers which encoding
is being used. The \l naturallanguage configuration variable
should also be specified to provide browsers with a complete
set of character encoding and language information.
See also \l outputencoding and \l naturallanguage.
\row
\o \bold outputformats \target outputformats
\o \bold {The \c outputformats variable specifies the format of
the generated documentation.}
Currently, QDoc only supports the HTML format. It is also
the default format, and doesn't need to be specified.
\row
\o \bold qhp \target qhp
\o \bold{The \c qhp variable is used to define the information to be
written out to Qt Help Project (\c{qhp}) files.}
See the \l{Creating Help Project Files} chapter for information
about this process.
\row
\o \bold slow \target slow
\o \bold {The \c slow variable specifies whether QDoc should do
time-consuming processing, such as syntax highlighting.}
By default, this setting is false.
Example:
\code
slow = true
\endcode
Another way to turn on "slowness" is to invoke QDoc with the
\c -slow command-line option.
\row
\o \bold sourcedirs \target sourcedirs
\o \bold {The \c sourcedirs variable specifies the directories
containing the \c .cpp or \c .qdoc files used in
the documentation.}
For example in \l qt.qdocconf
\code
sourcedirs = $QTDIR/src \
$QTDIR/doc/src \
$QTDIR/extensions/activeqt \
$QTDIR/extensions/motif \
$QTDIR/tools/designer/src/lib/extension \
$QTDIR/tools/designer/src/lib/sdk \
$QTDIR/tools/designer/src/lib/uilib
\endcode
When executed, the first QDoc will do is to read through
the headers specified in the \l {header}{\c header}
variable, and the ones located in the directories specified
in the \c headerdir variable (including all
subdirectories), building an internal structure of the
classes and their functions.
Then it will read through the sources specified in the \l
{sources}{\c sources}, and the ones located in the
directories specified in the \l {sourcedirs}{\c sourcedirs}
varible (including all subdirectories), merging the
documentation with the structure it retrieved from the
header files.
If both the \c sources and \c sourcedirs variables are
defined, QDoc will read through both, first \l {sources}{\c
sources} then \c sourcedirs.
In the specified directories, QDoc will only read the files
with the fileextensions specified in the \l
{sources.fileextensions}{\c sources.fileextensions}
variable. The default extensions are *.c++, *.cc, *.cpp and
*.cxx. The files specified by \l {sources}{\c sources} will
be read independent of their fileextensions.
See also \l sources and \l sources.fileextensions.
\row
\o \bold sourceencoding \target sourceencoding
\o \bold {The \c sourceencoding variable specifies the encoding
used for the source code and documentation.}
For example:
\code
sourceencoding = UTF-8
\endcode
By default, the source encoding is \c ISO-8859-1 (Latin1) for
compatibility with legacy documentation. For some languages,
particularly non-European languages, this is not sufficient
and an encoding such as UTF-8 is required.
Although qdoc will use the encoding to read source and
documentation files, limitations of C++ compilers may prevent
you from using non-ASCII characters in source code comments.
In cases like these, it is possible to write API documentation
completely in documentation files.
See also \l naturallanguage and \l outputencoding.
\row
\o \bold sources \target sources
\o \bold {The \c sources variable allows you to specify
individual source files in addition to those located in the
directories specified by the \l {sourcedir}{\c sourcedir}
variable.}
For example:
\code
sources = $QTDIR/src/gui/widgets/qlineedit.cpp \
$QTDIR/src/gui/widgets/qpushbutton.cpp
\endcode
When processing the \c sources variable, QDoc behaves in the
same way as it does when processing the \l {sourcedirs}{\c
sourcedirs} variable. For more information, see the \l
{sourcedirs}{\c sourcedirs} variable.
See also \l sourcedirs.
\row
\o \bold sources.fileextensions \target sources.fileextensions
\o \bold {The \c sources.fileextensions variable filters the
files within a source directory.}
When processing the source files specified in the \l
{sourcedirs}{\c sourcedirs} variable, QDoc will only read
the files with the fileextensions specified in the \c
sources.fileextensions variable. In this way QDoc avoid
spending time reading irrelevant files.
The default extensions are *.c++, *.cc, *.cpp and *.cxx.
The extensions are given as standard wildcard expressions.
You can add a file extension to the filter using '+='. For
example:
\code
sources.fileextensions += *.CC
\endcode
\warning The above assignment may not work as described.
See also \l sourcedirs and \l sources.
\row
\o \bold spurious \target spurious
\o \bold {The \c spurious variable excludes specified
QDoc warnings from the output.}
The warnings are specified using standard wildcard
expressions. For example:
\code
spurious = "Cannot find .*" \
"Missing .*"
\endcode
makes sure that warnings matching either of these
expressions, will not be part of the output when running
QDoc. For example would the following warning be omitted
from the output:
\code
qt-4.0/src/opengl/qgl_mac.cpp:156: Missing parameter name
\endcode
\row
\o \bold tabsize \target tabsize
\o \bold {The \c tabsize variable defines the size of a tab
character.}
For example:
\code
tabsize = 4
\endcode
will give the tab character the size of 4 spaces.
The default value of the variable is 8, and doesn't need to
be specified.
\row
\o \bold tagfile \target tagfile
\o \bold{The \c tagfile variable specifies the Doxygen tag file to be written
when HTML is generated.}
\row
\o \bold version \target version
\o \bold {The \c version variable specifies the version number of the
documented software.}
For example:
\code
version = 4.0.1
\endcode
When a version number is specified (using the \tt{\l
version} or \tt {\l versionsym} variables in a \c .qdocconf
file), it is accessible through the corresponding \\version
command for use in the documentation.
\warning The \\version command's functionality is not
fully implemented; currently it only works within raw HTML
code.
See also \l versionsym.
\row
\o \bold versionsym \target versionsym
\o \bold {The \c versionsym variable specifies a C++
preprocessor symbol that defines the version number
of the documented software.}
For example in \l qt.qdocconf:
\code
versionsym = QT_VERSION_STR
\endcode
QT_VERSION_STR is defined in qglobal.h as follows
\code
#define QT_VERSION_STR "4.0.1"
\endcode
When a version number is specified (using the \tt{\l
version} or \tt {\l versionsym} variables in a \c .qdocconf
file), it is accessible through the corresponding \\version
command for use in the documentation.
\warning The \\version command's functionality is not fully
implemented; currently it only works within raw HTML code.
See also \l {version}{\\version}.
\endtable
*/
/*!
\page 22-creating-help-project-files.html
\previouspage General Configuration Variables
\contentspage QDoc Manual - Table of Contents
\nextpage C++ Specific Configuration Variables
\title Creating Help Project Files
\section1 Overview
Starting with Qt 4.4, Qt Assistant uses a different system for managing
Qt documentation that requires QDoc to generate inventories of files in a
format that is similar to the old style DCF format, but with additional
features.
Instead of hard-coding information about the documentation sets for Qt,
QDoc allows configuration variables to be used to specify which pages are
to be used in each documentation set it generates. These are specified as
subvariables of the \c qch variable with each set declared using a unique
identifier as a subvariable.
For example, the configuration file for the Qt documentation defines a
\c Qt documentation set by specifying information about the set as
subvariables with the \c{qhp.Qt} prefix:
\code
qhp.Qt.file = qt.qhp
qhp.Qt.namespace = com.trolltech.qt.440
qhp.Qt.virtualFolder = qdoc
qhp.Qt.indexTitle = Qt Reference Documentation
qhp.Qt.indexRoot =
qhp.Qt.extraFiles = classic.css images/qt-logo.png
qhp.Qt.filterAttributes = qt 4.4.0 qtrefdoc
qhp.Qt.customFilters.Qt.name = Qt 4.4.0
qhp.Qt.customFilters.Qt.filterAttributes = qt 4.4.0
qhp.Qt.subprojects = classes overviews examples
qhp.Qt.subprojects.classes.title = Classes
qhp.Qt.subprojects.classes.indexTitle = Qt's Classes
qhp.Qt.subprojects.classes.selectors = class
qhp.Qt.subprojects.overviews.title = Overviews
qhp.Qt.subprojects.overviews.indexTitle = All Overviews and HOWTOs
qhp.Qt.subprojects.overviews.selectors = fake:page,group,module
qhp.Qt.subprojects.examples.title = Tutorials and Examples
qhp.Qt.subprojects.examples.indexTitle = Qt Examples
qhp.Qt.subprojects.examples.selectors = fake:example
\endcode
To create a table of contents for a manual, create a subproject with
a \c{type} property and set it to \c{manual}. The page in the documentation
referred to by the \c{indexTitle} property must contain a list of links
that acts as a table of contents for the whole manual. QDoc will take the
information in this list and create a table of contents for the subproject.
For example, the configuration file for Qt Creator defines only one
subproject for its documentation, including all the documentation in a
single manual:
\code
qhp.QtCreator.subprojects = manual
qhp.QtCreator.subprojects.manual.title = Qt Creator Manual
qhp.QtCreator.subprojects.manual.indexTitle = Qt Creator Manual
qhp.QtCreator.subprojects.manual.type = manual
\endcode
In this example, the page entitled "Qt Creator Manual" contains a nested
list of links to pages in the documentation which is duplicated in
Qt Assistant's Contents tab.
*/
/*!
\page 23-qdoc-configuration-cppvariables.html
\previouspage Creating Help Project Files
\contentspage QDoc Manual - Table of Contents
\nextpage HTML Specific Configuration Variables
\title C++ Specific Configuration Variables
The C++ specific configuration variables are provided to avoid
erroneous documentation due to non-standard C++ constructs.
\section1 Alphabetical List
\l {23-qdoc-configuration-cppvariables.html#Cpp.ignoredirectives}
{Cpp.ignoredirectives},
\l {23-qdoc-configuration-cppvariables.html#Cpp.ignoretoken}
{Cpp.ignoretokens}
\section1 Variable Descriptions
\table
\header
\o Variable
\o Description
\row
\o \bold Cpp.ignoredirectives \target Cpp.ignoredirectives
\o \bold {The \c Cpp.ignoredirectives variable makes QDoc ignore
the specified non-standard constructs, within C++ source code.}
If not specified by the \tt {\l Cpp.ignoretokens} or \tt
{\l Cpp.ignoredirectives} variables, non-standard
constructs (typically macros) can result in erroneous
documentation.
In \l qt.qdocconf:
\code
Cpp.ignoredirectives = Q_DECLARE_INTERFACE \
Q_DECLARE_OPERATORS_FOR_FLAGS \
Q_DECLARE_PRIVATE \
Q_DECLARE_PUBLIC \
Q_DISABLE_COPY \
Q_DUMMY_COMPARISON_OPERATOR \
Q_ENUMS \
Q_FLAGS \
Q_INTERFACES \
__attribute__
\endcode
makes sure that when processing the code below, for
example, QDoc will simply ignore the 'Q_ENUMS' and
'Q_FLAGS' expressions:
\code
class Q_CORE_EXPORT Qt {
Q_OBJECT
Q_ENUMS(Orientation TextFormat BackgroundMode
DateFormat ScrollBarPolicy FocusPolicy
ContextMenuPolicy CaseSensitivity
LayoutDirection ArrowType)
Q_ENUMS(ToolButtonStyle)
Q_FLAGS(Alignment)
Q_FLAGS(Orientations)
Q_FLAGS(DockWidgetAreas)
public:
...
};
\endcode
The Q_OBJECT macro, however, is an exception: QDoc
recognizes this particular non-standard construct, so there
is no need specifying it using the \tt {\l
Cpp.ignoredirectives} variable.
Regarding the Q_CORE_EXPORT macro; see the documentation of
the \tt {\l Cpp.ignoretokens} variable.
See also \l Cpp.ignoretokens.
\row
\o \bold Cpp.ignoretokens \target Cpp.ignoretokens
\o \bold {The \c Cpp.ignoretokens variable makes QDoc ignore
the specified non-standard constructs, within C++ source code.}
If not specified by the \tt {\l Cpp.ignoretokens} or \tt
{\l Cpp.ignoredirectives} variables, non-standard
constructs (typically macros) can result in erroneous
documentation.
In \l qt.qdocconf:
\code
Cpp.ignoretokens = QAXFACTORY_EXPORT \
QM_EXPORT_CANVAS \
...
Q_COMPAT_EXPORT \
Q_CORE_EXPORT \
Q_EXPLICIT \
Q_EXPORT \
...
Q_TYPENAME \
Q_XML_EXPORT
\endcode
makes sure that when processing the code below, for
example, QDoc will simply ignore the 'Q_CORE_EXPORT'
expression:
\code
class Q_CORE_EXPORT Qt {
Q_OBJECT
Q_ENUMS(Orientation TextFormat BackgroundMode
DateFormat ScrollBarPolicy FocusPolicy
ContextMenuPolicy CaseSensitivity
LayoutDirection ArrowType)
Q_ENUMS(ToolButtonStyle)
Q_FLAGS(Alignment)
Q_FLAGS(Orientations)
Q_FLAGS(DockWidgetAreas)
public:
...
};
\endcode
Regarding the Q_OBJECT, Q_ENUMS and Q_FLAGS macros; see the
documentation of the \tt {\l Cpp.ignoredirectives}
variable.
See also \l Cpp.ignoredirectives.
\endtable
*/
/*!
\page 24-qdoc-configuration-htmlvariables.html
\previouspage C++ Specific Configuration Variables
\contentspage QDoc Manual - Table of Contents
\nextpage Supporting Derived Projects
\title HTML Specific Configuration Variables
The HTML specific configuration variables define the generated
documentation's style, or define the contents of the
documentation's footer or postheader. The format of the variable
values are raw HTML.
\section1 Alphabetical List
\l {24-qdoc-configuration-htmlvariables.html#HTML.footer}{HTML.footer},
\l {24-qdoc-configuration-htmlvariables.html#HTML.postheader}
{HTML.postheader},
\l {24-qdoc-configuration-htmlvariables.html#HTML.style}{HTML.style},
\l {24-qdoc-configuration-htmlvariables.html#HTML.stylesheets}{HTML.stylesheets}
\section1 Variable Descriptions
\table
\header
\o Variable
\o Description
\row
\o \bold HTML.footer \target HTML.footer
\o \bold {The \c HTML.footer variable defines the content
of the generated HTML documentation's footer.}
The footer is rendered at the bottom of the generated
documentation page.
The variable's value is given as raw HTML code enclosed by
quotation marks. Note that if the value spans several
lines, each line needs to be enclosed by quotation marks.
For example in \l qt.qdocconf:
\code
HTML.footer = "\n" \
...
"
"
\endcode
The complete variable entry in \l qt.qdocconf provides the
standard footer of the \l
{http://qt.nokia.com/doc/4.0/index.html}{Qt Reference
Documentation}.
\row
\o \bold HTML.postheader \target HTML.postheader
\o \bold {The \c HTML.postheader variable defines the content
of the generated HTML documentation's postheader.}
The header is rendered at the top of the generated
documentation page.
The variable's value is given as raw HTML enclosed by
quotation marks. Note that if the value spans several
lines, each line needs to be enclosed by quotation marks.
For example in \l qt.qdocconf:
\code
HTML.postheader = "