summaryrefslogtreecommitdiffstats
path: root/tools
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@nokia.com>2011-02-25 08:43:59 (GMT)
committerMartin Smith <martin.smith@nokia.com>2011-02-25 08:43:59 (GMT)
commitd068fc93425cce786d74d8f6d4376a4fdfc49914 (patch)
tree4856fd733fd5912ecaf2a861eeef078dc8b9c32a /tools
parentf65e8376f14a189675c225cfb562df985babe544 (diff)
downloadQt-d068fc93425cce786d74d8f6d4376a4fdfc49914.zip
Qt-d068fc93425cce786d74d8f6d4376a4fdfc49914.tar.gz
Qt-d068fc93425cce786d74d8f6d4376a4fdfc49914.tar.bz2
qdoc: More updating command descriptions.
Diffstat (limited to 'tools')
-rw-r--r--tools/qdoc3/doc/qdoc-manual.qdoc1464
1 files changed, 695 insertions, 769 deletions
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index faabe2c..afe8082 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -6579,7 +6579,7 @@
temporary-command-name}.
\code
- alias.i = e
+ alias.i = e
\endcode
This renames the built-in command \\i (italics) to \\e. The \c
@@ -6592,8 +6592,8 @@
\target codeindent-variable
\section1 codeindent
- The \c codeindent variable specifies the level of
- indentation that QDoc uses when writing code snippets.
+ 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
@@ -6605,8 +6605,8 @@
\target defines-variable
\section1 defines
- The \c defines variable specifies the C++ preprocessor
- symbols that QDoc will recognize and respond to.
+ 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-command} {\\if} command to
@@ -6618,25 +6618,25 @@
protected with #ifdef...#endif will be ignored.
\code
- defines = Q_QDOC \
- QT_.*_SUPPORT \
- QT_.*_LIB \
- QT_COMPAT \
- QT3_SUPPORT \
- Q_WS_.* \
- Q_OS_.* \
- Q_BYTE_ORDER \
- __cplusplus
+ defines = Q_QDOC \
+ QT_.*_SUPPORT \
+ QT_.*_LIB \
+ QT_COMPAT \
+ QT3_SUPPORT \
+ Q_WS_.* \
+ Q_OS_.* \
+ Q_BYTE_ORDER \
+ __cplusplus
\endcode
This 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
+ #ifdef Q_WS_WIN
+ HDC getDC() const;
+ void releaseDC(HDC) const;
+ #endif
\endcode
Since the Q_WS_.* regular expression (specified using the \c
@@ -6659,550 +6659,522 @@
\target edition-variable
\section1 edition
- 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.
+ 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.
+ 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:
+ 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#generatelist-command} {generatelist} command
- is used to generate a list of classes for this 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
- \code
- \generatelist{classesbyedition Console}
- \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#generatelist-command}
+ {generatelist} command is used to generate a list of classes for
+ this edition:
+ \code
+ \generatelist{classesbyedition Console}
+ \endcode
\target exampledirs-variable
\section1 exampledirs
- The \c exampledirs variable specifies the directories
- containing the source code of the example files.
-
- The \l {examples-variable} {examples} {examples} and \l
- {exampledirs-variable} {exampledirs} variables are used by
- the \l {quotefromfile-command} {\\quotefromfile}, \l
- {quotefile-command} {\\quotefile} and \l {example-command}
- {\\example} commands. If both the \l {examples-variable}
- {examples} and \l {exampledirs-variable} {exampledirs}
- variables are defined, QDoc will search in both, first in
- \l {examples-variable} {examples} then in \l
- {exampledirs-variable} {exampledirs}.
+ The \c exampledirs variable specifies the directories containing
+ the source code of the example files.
- 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, \e not in
- subdirectories.
+ The \l {examples-variable} {examples} {examples} and \l
+ {exampledirs-variable} {exampledirs} variables are used by the \l
+ {quotefromfile-command} {\\quotefromfile}, \l {quotefile-command}
+ {\\quotefile} and \l {example-command} {\\example} commands. If
+ both the \l {examples-variable} {examples} and \l
+ {exampledirs-variable} {exampledirs} variables are defined, QDoc
+ will search in both, first in \l {examples-variable} {examples}
+ then in \l {exampledirs-variable} {exampledirs}.
- \code
- exampledirs = $QTDIR/doc/src \
- $QTDIR/examples \
- $QTDIR \
- $QTDIR/qmake/examples
+ 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, \e not in subdirectories.
- examples = $QTDIR/examples/widgets/analogclock/analogclock.cpp
- \endcode
+ \code
+ exampledirs = $QTDIR/doc/src \
+ $QTDIR/examples \
+ $QTDIR \
+ $QTDIR/qmake/examples
- When processing
+ examples = $QTDIR/examples/widgets/analogclock/analogclock.cpp
+ \endcode
- \code
- \quotefromfile widgets/calculator/calculator.cpp
- \endcode
+ When processing
- 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
+ \quotefromfile widgets/calculator/calculator.cpp
+ \endcode
- \code
- $QTDIR/doc/src/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
- If it doesn't, QDoc will continue looking for a file
- called
+ \code
+ $QTDIR/doc/src/widgets/calculator/calculator.cpp
+ \endcode
- \code
- $QTDIR/examples/widgets/calculator/calculator.cpp
- \endcode
+ If it doesn't, QDoc will continue looking for a file called
- and so forth.
+ \code
+ $QTDIR/examples/widgets/calculator/calculator.cpp
+ \endcode
- See also \l examples.
+ and so forth.
+ See also \l examples.
\target examples-variable
\section1 examples
- The \c examples variable allows you to specify individual
- example files in addition to those located in the directories
- specified by the \l {exampledirs-variable} {\c exampledirs} variable.
-
- The \c examples and \l {exampledirs-variable} {\c exampledirs}
- variables are used by the \l {quotefromfile-command} {\\quotefromfile},
- \l {quotefile-command} {\\quotefile} and \l {example}
- {\\example} commands. If both the \c examples and \l {exampledirs-variable}
- {\c exampledirs} variables are defined, QDoc will search in both, first in
- \c examples then in \l {exampledirs-variable} {\c exampledirs}.
+ The \c examples variable allows you to specify individual example
+ files in addition to those located in the directories specified by
+ the \l {exampledirs-variable} {\c exampledirs} variable.
- QDoc will search through the values listed for the \c examples
- variable, in the specified order, and accept the
- first one it finds.
+ The \c examples and \l {exampledirs-variable} {\c exampledirs}
+ variables are used by the \l {quotefromfile-command}
+ {\\quotefromfile}, \l {quotefile-command} {\\quotefile} and \l
+ {example} {\\example} commands. If both the \c examples and \l
+ {exampledirs-variable} {\c exampledirs} variables are defined,
+ QDoc will search in both, first in \c examples then in \l
+ {exampledirs-variable} {\c exampledirs}.
- For an extensive example, see the \l {exampledirs-variable}
- {\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:
+ QDoc will search through the values listed for the \c examples
+ variable, in the specified order, and accept the first one it
+ finds.
- \code
- \quotefromfile calculator.cpp
- \endcode
+ For an extensive example, see the \l {exampledirs-variable} {\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:
- See also \l {exampledirs-variable} {exampledirs}.
+ \code
+ \quotefromfile calculator.cpp
+ \endcode
+ See also \l {exampledirs-variable} {exampledirs}.
\target examples.fileextensions-variable
\section1 examples.fileextensions
- The \c examples.fileextensions variable specifies the
- file extensions that qdoc will look for when collecting example
- files for display in the documentation.
+ 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 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
+ The extensions are given as standard wildcard expressions. You
+ can add a file extension to the filter using '+='. For example:
- See also \l{headers.fileextensions}.
+ \code
+ examples.fileextensions += *.qrc
+ \endcode
+ See also \l{headers.fileextensions}.
\target extraimages-variable
\section1 extraimages
- The \c extraimages variable tells QDoc to incorporate
- specific images in the generated documentation.
+ 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.
+ 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.\e{format} = \e
- image}. The file extension is optional.
+ The general syntax is \tt {extraimages.\e{format} = \e 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:
+ 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.
+ \code
+ extraimages.HTML = qt-logo
+ \endcode
+ See also \l images and \l imagedirs.
\target falsehoods-variable
\section1 falsehoods
- The \c falsehoods variable defines the truth value of
- specified preprocessor symbols as false.
+ 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.
+ 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:
+ QDoc will recognize, and is able to evaluate, the following
+ preprocessor syntax:
- \code
- #ifdef NOTYET
- ...
- #endif
+ \code
+ #ifdef NOTYET
+ ...
+ #endif
- #if defined (NOTYET)
- ...
- #end if
- \endcode
+ #if defined (NOTYET)
+ ...
+ #end if
+ \endcode
- However, faced with unknown syntax like
+ However, faced with unknown syntax like
- \code
- #if NOTYET
- ...
- #endif
- \endcode
-
- QDoc will evaluate it as true by default, \e unless the
- preprocessor symbol is specified within the \c falsehoods
- variable entry:
+ \code
+ #if NOTYET
+ ...
+ #endif
+ \endcode
- \code
- falsehoods = NOTYET
- \endcode
+ QDoc will evaluate it as true by default, \e unless the
+ preprocessor symbol is specified within the \c falsehoods variable
+ entry:
- See also \l defines.
+ \code
+ falsehoods = NOTYET
+ \endcode
+ See also \l defines.
\target generateindex-variable
\section1 generateindex
The \c generateindex variable contains a boolean value that
- specifies whether to generate an index file when HTML documentation
- is generated.
+ 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).
+ 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).
\target headerdirs-variable
\section1 headerdirs
- The \c headerdirs variable specifies the directories
- containing the header files associated with the \c .cpp source
- files used in the documentation.
-
- \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
+ The \c headerdirs variable specifies the directories containing
+ the header files associated with the \c .cpp source files used in
+ the documentation.
- 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.
+ \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
- Then it will read through the sources specified in the \l
- {sources-variable} {\c sources}, and the ones located in the
- directories specified in the \l {sourcedirs-variable}
- {\c sourcedirs}
- varible (including all subdirectories), merging the
- documentation with the structure it retrieved from the
- header files.
+ 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.
- If both the \c headers and \c headerdirs variables are
- defined, QDoc will read through both, first \l {headers} {\c
- headers} then \c headerdirs.
+ Then it will read through the sources specified in the \l
+ {sources-variable} {\c sources}, and the ones located in the
+ directories specified in the \l {sourcedirs-variable} {\c
+ sourcedirs} varible (including all subdirectories), merging the
+ documentation with the structure it retrieved from the header
+ files.
- 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.
+ If both the \c headers and \c headerdirs variables are defined,
+ QDoc will read through both, first \l {headers} {\c headers} then
+ \c headerdirs.
- See also \l headers and \l headers.fileextensions.
+ 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.
\target headers-variable
\section1 headers
- 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.
-
- \code
- headers = $QTDIR/src/gui/widgets/qlineedit.h \
- $QTDIR/src/gui/widgets/qpushbutton.h
- \endcode
+ 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.
- 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.
+ \code
+ headers = $QTDIR/src/gui/widgets/qlineedit.h \
+ $QTDIR/src/gui/widgets/qpushbutton.h
+ \endcode
- See also \l headerdirs.
+ 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.
\target headers.fileextensions-variable
\section1 headers.fileextensions
- The \c headers.fileextensions variable specify the
- extension used by the headers.
+ 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.
+ 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 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:
+ 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.
+ \code
+ header.fileextensions += *.H
+ \endcode
- See also \l headerdirs.
+ \warning The above assignment may not work as described.
+ See also \l headerdirs.
\target imagedirs-variable
\section1 imagedirs
- 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-command} {\\image} and \l
- {inlineimage-command} {\\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.
+ The \c imagedirs variable specifies the directories containing the
+ images used in the documentation.
- 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, \e not in
- subdirectories.
+ The \l {images} {\c images} and \c imagedirs variables are used by
+ the \l {image-command} {\\image} and \l {inlineimage-command}
+ {\\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.
- \code
- imagedirs = $QTDIR/doc/src/images \
- $QTDIR/examples
+ 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, \e not in subdirectories.
- images = $QTDIR/doc/src/images/calculator-example.png
- \endcode
+ \code
+ imagedirs = $QTDIR/doc/src/images \
+ $QTDIR/examples
- When processing
+ images = $QTDIR/doc/src/images/calculator-example.png
+ \endcode
- \code
- \image calculator-example.png
- \endcode
+ When processing
- 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
+ \image calculator-example.png
+ \endcode
- \code
- $QTDIR/doc/src/images/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
- If it doesn't, QDoc will look for a file called
+ \code
+ $QTDIR/doc/src/images/calculator-example.png
+ \endcode
- \code
- $QTDIR/examples/calculator-example.png
- \endcode
+ If it doesn't, QDoc will look for a file called
- 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.
+ \code
+ $QTDIR/examples/calculator-example.png
+ \endcode
- \warning The \l {images.fileextensions} {\c
- images.fileextensions} variable's functionality is
- preliminay since QDoc at this point only support HTML.
+ 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.
- See also \l images and \l images.fileextensions.
+ \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.
\target images-variable
\section1 images
- 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.
-
- \code
- images = $QTDIR/doc/src/images/calculator-example.png
- \endcode
+ 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.
- 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.
+ \code
+ images = $QTDIR/doc/src/images/calculator-example.png
+ \endcode
- See also \l imagedirs and \l images.fileextensions.
+ 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.
\target images.fileextensions-variable
\section1 images.fileextensions
- The images.fileextensions variable filters the files within
- an image directory.
+ 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.\e{format} = *.\e{extension}}.
+ The variable's values (the extensions) are given as standard
+ wildcard expressions. The general syntax is: \tt
+ {images.fileextensions.\e{format} = *.\e{extension}}.
- The idea is to enable different image format for different
- output format.
+ The idea is to enable different image format for different output
+ format.
- \code
- images.fileextensions.HTML = *.png
- images.fileextensions.LOUT = *.eps
- \endcode
-
- Then, when processing the \l {image-command} {\\image} and \l
- {inlineimage-command} {\\inlineimage} commands, QDoc will only
- search for files with extensions specified in the output
- format's associated image extension variable.
+ \code
+ images.fileextensions.HTML = *.png
+ images.fileextensions.LOUT = *.eps
+ \endcode
- \warning This is preliminary functionality since QDoc at
- this point only support HTML.
+ Then, when processing the \l {image-command} {\\image} and \l
+ {inlineimage-command} {\\inlineimage} commands, QDoc will only
+ search for files with extensions specified in the output format's
+ associated image extension variable.
- The default extensions for HTML are *.png, *.jpg, *.jpeg
- and *.gif.
+ \warning This is preliminary functionality since QDoc at this
+ point only support HTML.
- You can add a file extension to the filter using '+='. For
- example:
+ The default extensions for HTML are *.png, *.jpg, *.jpeg and
+ *.gif.
- \code
- images.fileextensions.HTML += *.eps
- \endcode
+ You can add a file extension to the filter using '+='. For
+ example:
- See also \l imagedirs and \l images.
+ \code
+ images.fileextensions.HTML += *.eps
+ \endcode
+ See also \l imagedirs and \l images.
\target language-variable
\section1 language
- The \c language variable specifies the language of the
- source code that is used in the documentation.
+ 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:
+ 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++.
+ \code
+ language = Cpp
+ \endcode
+ identifies the language of the Qt source code as C++.
\target macro-variable
\section1 macro
- The \c macro variable can be used to create your
- own QDoc commands.
-
- The general syntax is \tt {macro.\e{command} =
- "\e{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.
+ The \c macro variable can be used to create your own QDoc
+ commands.
- For example in \l qt.qdocconf:
+ The general syntax is \tt {macro.\e{command} =
+ "\e{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.
- \code
- macro.gui = "\\bold"
- macro.raisedaster.HTML = "<sup>*</sup>"
- \endcode
+ For example in \l qt.qdocconf:
- makes sure that the \\gui command renders its argument using a
- bold font, and that \\raisedaster renders a '*'.
+ \code
+ macro.gui = "\\bold"
+ macro.raisedaster.HTML = "<sup>*</sup>"
+ \endcode
+ makes sure that the \\gui command renders its argument using a
+ bold font, and that \\raisedaster renders a '*'.
\target naturallanguage-variable
\section1 naturallanguage
- The \c naturallanguage variable specifies the natural
- language used for the documentation generated by qdoc.
-
- \code
- naturallanguage = zh-Hans
- \endcode
+ The \c naturallanguage variable specifies the natural language
+ used for the documentation generated by qdoc.
- By default, the natural language is \c en for compatibility
- with legacy documentation.
+ \code
+ naturallanguage = zh-Hans
+ \endcode
- qdoc will add the natural language information to the HTML
- it generates, using the \c lang and \c xml:lang attributes.
+ By default, the natural language is \c en for compatibility with
+ legacy documentation.
- See also \l {sourceencoding-variable} {sourceencoding},
- \l {outputencoding-variable} {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}.
+ 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-variable} {sourceencoding},
+ \l {outputencoding-variable} {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}.
\target outputdir-variable
\section1 outputdir
- The \c outputdir variable specifies the directory
- where QDoc will put the generated documentation.
+ The \c outputdir variable specifies the directory where QDoc will
+ put the generated documentation.
- In qt.qdocconf:
+ 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
+ outputdir = $QTDIR/doc/html
+ \endcode
- \code
- $QTDIR/doc/html/qwidget.html
- \endcode
+ locates the generated Qt reference documentation in
+ $QTDIR/doc/html. For example, the documentation of the QWidget
+ class is located in
- The associated images will be put in an \c images subdirectory.
+ \code
+ $QTDIR/doc/html/qwidget.html
+ \endcode
- \warning When running QDoc multiple times using the same output
- directory, all files from the previous run will be lost.
+ 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.
\target outputencoding-variable
\section1 outputencoding
- The \c outputencoding variable specifies the encoding
- used for the documentation generated by qdoc.
+ The \c outputencoding variable specifies the encoding used for the
+ documentation generated by qdoc.
- \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.
+ \code
+ outputencoding = UTF-8
+ \endcode
- 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.
+ 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.
- See also \l outputencoding and \l naturallanguage.
+ 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.
\target outputformats-variable
\section1 outputformats
@@ -7210,26 +7182,24 @@
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.
-
+ Currently, QDoc only supports the HTML format. It is also
+ the default format, and doesn't need to be specified.
\target outputprefixes
\section1 outputprefixes
- The \c outputprefixes variable specifies a mapping between types of files
- and the prefixes to prepend to the HTML file names in the generated
- documentation.
-
- \code
- outputprefixes = QML
- outputprefixes.QML = qt-components-
- \endcode
+ The \c outputprefixes variable specifies a mapping between types of files
+ and the prefixes to prepend to the HTML file names in the generated
+ documentation.
- By default, files containing the API documentation for QML elements
- or components are prefixed with "qml-". In the above example, the
- prefix "qt-components-" is used instead.
+ \code
+ outputprefixes = QML
+ outputprefixes.QML = qt-components-
+ \endcode
+ By default, files containing the API documentation for QML elements
+ or components are prefixed with "qml-". In the above example, the
+ prefix "qt-components-" is used instead.
\target qhp-variable
\section1 qhp
@@ -7245,90 +7215,80 @@
\section1 slow
The \c slow variable specifies whether QDoc should do
- time-consuming processing, such as syntax highlighting.
-
- By default, this setting is false.
+ time-consuming processing, such as syntax highlighting. The
+ default value is false.
- Example:
-
- This option has been replaced by the \l{syntaxhighlighting} option.
-
- For compatibility, the \c -slow command-line option has been
- retained. This has the effect of enabling syntax highlighting.
+ \note This option has been replaced by the \l{syntaxhighlighting} option.
+ For compatibility, the \c -slow command-line option has been
+ retained. This has the effect of enabling syntax highlighting.
\target sourcedirs-variable
\section1 sourcedirs
- The \c sourcedirs variable specifies the directories
- containing the \c .cpp or \c .qdoc files used in
- the documentation.
+ 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
+ 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-command} {\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.
+ \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
- 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.
+ When executed, the first QDoc will do is to read through the
+ headers specified in the \l {header-command} {\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.
- If both the \c sources and \c sourcedirs variables are
- defined, QDoc will read through both, first \l {sources} {\c
- sources} then \c sourcedirs.
+ 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.
- 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.
+ If both the \c sources and \c sourcedirs variables are defined,
+ QDoc will read through both, first \l {sources} {\c sources} then
+ \c sourcedirs.
- See also \l {sources-variable} {sources} and
- \l {sources.fileextensions-variable} {sources.fileextensions}.
+ 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-variable} {sources} and
+ \l {sources.fileextensions-variable} {sources.fileextensions}.
\target sourceencoding-variable
\section1 sourceencoding
- The \c sourceencoding variable specifies the encoding
- used for the source code and documentation.
+ The \c sourceencoding variable specifies the encoding used for the
+ source code and documentation.
- \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.
+ \code
+ sourceencoding = UTF-8
+ \endcode
- 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.
+ 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.
- See also \l {naturallanguage-variable} {naturallanguage} and
- \l {outputencoding-variable} {outputencoding}.
+ 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-variable} {naturallanguage} and
+ \l {outputencoding-variable} {outputencoding}.
\target sources-variable
\section1 sources
@@ -7337,105 +7297,96 @@
files in addition to those located in the directories specified by
the \l {sourcedirs-variable} {sourcedirs} variable.
- \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-variable}
- {sourcedirs} variable. For more information, see the \l
- {sourcedirs-variable} {sourcedirs} variable.
+ \code
+ sources = $QTDIR/src/gui/widgets/qlineedit.cpp \
+ $QTDIR/src/gui/widgets/qpushbutton.cpp
+ \endcode
- See also \l {sourcedirs-variable} {sourcedirs}.
+ When processing the \c sources variable, QDoc behaves in the same
+ way as it does when processing the \l {sourcedirs-variable}
+ {sourcedirs} variable. For more information, see the \l
+ {sourcedirs-variable} {sourcedirs} variable.
+ See also \l {sourcedirs-variable} {sourcedirs}.
\target sources.fileextensions-variable
\section1 sources.fileextensions
- The \c sources.fileextensions variable filters the
- files within a source directory.
+ 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.
+ 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 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:
+ 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
+ \code
+ sources.fileextensions += *.CC
+ \endcode
- \warning The above assignment may not work as described.
+ \warning The above assignment may not work as described.
- See also \l {sourcedirs-variable} {sourcedirs} and
- \l (sources-variable} {sources}.
+ See also \l {sourcedirs-variable} {sourcedirs} and \l
+ (sources-variable} {sources}.
\target spurious-variable
\section1 spurious
- The \c spurious variable excludes specified
- QDoc warnings from the output.
-
- The warnings are specified using standard wildcard
- expressions.
+ The \c spurious variable excludes specified QDoc warnings from the
+ output. The warnings are specified using standard wildcard
+ expressions.
- \code
- spurious = "Cannot find .*" \
- "Missing .*"
- \endcode
+ \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:
+ 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
+ \code
+ qt-4.0/src/opengl/qgl_mac.cpp:156: Missing parameter name
+ \endcode
\target syntaxhighlighting
\section1 syntaxhighlighting
- The \c syntaxhighlighting variable specifies whether QDoc
- should perform syntax highlighting on source code quoted in the
- documentation it generates.
+ The \c syntaxhighlighting variable specifies whether QDoc should
+ perform syntax highlighting on source code quoted in the
+ documentation it generates.
- \code
- syntaxhighlighting = true
- \endcode
-
- will enable syntax highlighting for all supported programming
- languages.
+ \code
+ syntaxhighlighting = true
+ \endcode
+ will enable syntax highlighting for all supported programming
+ languages.
\target tabsize-variable
\section1 tabsize
The \c tabsize variable defines the size of a tab character.
- \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.
+ \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.
\target tagfile-variable
\section1 tagfile
-
- The \c tagfile variable specifies the Doxygen tag file to be written
- when HTML is generated.
+
+ The \c tagfile variable specifies the Doxygen tag file to be
+ written when HTML is generated.
\target version-variable
\section1 version
@@ -7443,52 +7394,47 @@
The \c version variable specifies the version number of the
documented software.
- \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.
+ \code
+ version = 4.0.1
+ \endcode
- \warning The \\version command's functionality is not
- fully implemented; currently it only works within raw HTML
- code.
+ 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.
- See also \l versionsym.
+ \warning The \\version command's functionality is not fully
+ implemented; currently it only works within raw HTML code.
+ See also \l versionsym.
\target versionsym-variable
\section1 versionsym
- 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
+ The \c versionsym variable specifies a C++ preprocessor symbol
+ that defines the version number of the documented software.
- QT_VERSION_STR is defined in qglobal.h as follows
+ For example in \l qt.qdocconf:
- \code
- #define QT_VERSION_STR "4.0.1"
- \endcode
+ \code
+ versionsym = QT_VERSION_STR
+ \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.
+ QT_VERSION_STR is defined in qglobal.h as follows
- \warning The \\version command's functionality is not fully
- implemented; currently it only works within raw HTML code.
+ \code
+ #define QT_VERSION_STR "4.0.1"
+ \endcode
- See also \l {version} {\\version}.
+ 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}.
*/
/*!
@@ -7574,118 +7520,107 @@
\target Cpp.ignoredirectives-variable
\section1 Cpp.ignoredirectives
- The \c Cpp.ignoredirectives variable makes QDoc ignore
- the specified non-standard constructs, within C++ source code.
+ 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.
+ 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:
+ 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
+ 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
- \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
+ makes sure that when processing the code below, for example, QDoc
+ will simply ignore the 'Q_ENUMS' and 'Q_FLAGS' expressions:
- 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.
+ \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_CORE_EXPORT macro; see the documentation of
- the \tt {\l Cpp.ignoretokens} variable.
+ 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.
- See also \l Cpp.ignoretokens.
+ Regarding the Q_CORE_EXPORT macro; see the documentation of the
+ \tt {\l Cpp.ignoretokens} variable.
+ See also \l Cpp.ignoretokens.
\target Cpp.ignoretokens-variable
\section1 Cpp.ignoretokens
- 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.
+ The \c Cpp.ignoretokens variable makes QDoc ignore the specified
+ non-standard constructs, within C++ source code.
- In \l qt.qdocconf:
+ 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.
- \code
- Cpp.ignoretokens = QAXFACTORY_EXPORT \
- QM_EXPORT_CANVAS \
- ...
- Q_COMPAT_EXPORT \
- Q_CORE_EXPORT \
- Q_EXPLICIT \
- Q_EXPORT \
- ...
- Q_TYPENAME \
- Q_XML_EXPORT
- \endcode
+ In \l qt.qdocconf:
- 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
+ \code
+ Cpp.ignoretokens = QAXFACTORY_EXPORT \
+ QM_EXPORT_CANVAS \
+ ...
+ Q_COMPAT_EXPORT \
+ Q_CORE_EXPORT \
+ Q_EXPLICIT \
+ Q_EXPORT \
+ ...
+ Q_TYPENAME \
+ Q_XML_EXPORT
+ \endcode
- Regarding the Q_OBJECT, Q_ENUMS and Q_FLAGS macros; see the
- documentation of the \tt {\l Cpp.ignoredirectives}
- variable.
+ makes sure that when processing the code below, for example, QDoc
+ will simply ignore the 'Q_CORE_EXPORT' expression:
- See also \l Cpp.ignoredirectives.
+ \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.
*/
-
/*!
\page 24-qdoc-configuration-htmlvariables.html
\previouspage C++ Specific Configuration Variables
@@ -7702,60 +7637,56 @@
\target HTML.footer-variable
\section1 HTML.footer
- 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 \c HTML.footer variable defines the content of the generated
+ HTML documentation's footer.
- 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.
+ The footer is rendered at the bottom of the generated
+ documentation page.
- For example in \l qt.qdocconf:
+ 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.
- \code
- HTML.footer = "<p /><address><hr /><div align=\"center\">\n" \
- ...
- "</tr></table></div></address>"
- \endcode
+ For example in \l qt.qdocconf:
- 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}.
+ \code
+ HTML.footer = "<p /><address><hr /><div align=\"center\">\n" \
+ ...
+ "</tr></table></div></address>"
+ \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}.
\target HTML.postheader-variable
\section1 HTML.postheader
- 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 \c HTML.postheader variable defines the content of the
+ generated HTML documentation's postheader.
- 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.
+ The header is rendered at the top of the generated documentation
+ page.
- For example in \l qt.qdocconf:
+ 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.
- \code
- HTML.postheader = "<table border=\"0\"..." \
- ...
- "<img src=\"images/trolltech-logo.png\" \
- "align=\"right\" width=\"203\" height=\"32\""\
- "border=\"0\" />" \
- "</td></tr>" \
- "</table>"
- \endcode
+ For example in \l qt.qdocconf:
- The complete variable entry in \l qt.qdocconf provides the
- standard header of the \l
- {http://qt.nokia.com/doc/4.0/index.html} {Qt Reference
- Documentation}.
+ \code
+ HTML.postheader = "<table border=\"0\"..." \
+ ...
+ "<img src=\"images/trolltech-logo.png\" \
+ "align=\"right\" width=\"203\" height=\"32\""\
+ "border=\"0\" />" \
+ "</td></tr>" \
+ "</table>"
+ \endcode
+ The complete variable entry in \l qt.qdocconf provides the
+ standard header of the \l {http://qt.nokia.com/doc/4.0/index.html}
+ {Qt Reference Documentation}.
\target HTML.style-variable
\section1 HTML.style
@@ -7763,27 +7694,26 @@
The HTML.style variable defines the style for
the generated HTML documentation.
- 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.
+ 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:
+ For example in \l qt.qdocconf:
- \code
- HTML.style = "h3.fn,span.fn" \
- "{ margin-left: 1cm; text-indent: -1cm; }\n" \
- "a:link { color: #004faf; text-decoration: none }\n" \
- "a:visited" \
- "{ color: #672967; text-decoration: none }\n" \
- "td.postheader { font-family: sans-serif }\n" \
- "tr.address { font-family: sans-serif }\n" \
- "body { background: #ffffff; color: black; }"
- \endcode
-
- provides the HTML style for the \l
- {http://qt.nokia.com/doc/4.0/index.html} {Qt Reference
- Documentation}.
+ \code
+ HTML.style = "h3.fn,span.fn" \
+ "{ margin-left: 1cm; text-indent: -1cm; }\n" \
+ "a:link { color: #004faf; text-decoration: none }\n" \
+ "a:visited" \
+ "{ color: #672967; text-decoration: none }\n" \
+ "td.postheader { font-family: sans-serif }\n" \
+ "tr.address { font-family: sans-serif }\n" \
+ "body { background: #ffffff; color: black; }"
+ \endcode
+ provides the HTML style for the \l
+ {http://qt.nokia.com/doc/4.0/index.html} {Qt Reference
+ Documentation}.
\target HTML.stylesheets-variable
\section1 HTML.stylesheets
@@ -7791,18 +7721,18 @@
The HTML.stylesheets variable defines a list of stylesheets
to use for the generated HTML documentation.
- Using separate stylesheets for the documentation makes it easier to
- customize and experiment with the style used once the contents has
- been generated. Typically, it is only necessary to define a single
- stylesheet for any set of documentation; for example:
+ Using separate stylesheets for the documentation makes it easier
+ to customize and experiment with the style used once the contents
+ has been generated. Typically, it is only necessary to define a
+ single stylesheet for any set of documentation; for example:
- \code
- HTML.stylesheets = classic.css
- \endcode
+ \code
+ HTML.stylesheets = classic.css
+ \endcode
- QDoc expects to find stylesheets in the directory containing the
- \l qt.qdocconf file, and it will copy those specified to the output
- directory alongside the HTML pages.
+ QDoc expects to find stylesheets in the directory containing the
+ \l qt.qdocconf file, and it will copy those specified to the output
+ directory alongside the HTML pages.
*/
@@ -7814,82 +7744,78 @@
\title Supporting Derived Projects
- Some particular configuration variables allow you to use QDoc to
- support Qt-based projects; i.e to make projects, such as Qt Solutions,
- contain references to the online Qt documentation. This
- means that QDoc will be able to create links to the class reference
- documentation, without any explicit linking command.
+ Some configuration variables allow you to use QDoc to support
+ Qt-based projects; i.e allow your project to contain links to the
+ online Qt documentation. This means that QDoc will be able to
+ create links to the class reference documentation, without any
+ explicit linking command.
\target description-variable
\section1 description
- The description variable holds a short description of
- the associated project.
-
- See also \l project.
+ The description variable holds a short description of the
+ associated project.
+ See also \l project.
\target indexes-variable
\section1 indexes
- The \c indexes variable lists the index files
- that will be used to generate references.
+ The \c indexes variable lists the index files that will be used to
+ generate references.
- For example. to make a derived Qt project contain links to
- the Qt Reference documentation, you need to specify the
- associated index file:
+ For example. to make a derived Qt project contain links to the Qt
+ Reference documentation, you need to specify the associated index
+ file:
- \code
- indexes = $QTDIR/doc/html/qt.index
- \endcode
-
- See also \l project and \l url.
+ \code
+ indexes = $QTDIR/doc/html/qt.index
+ \endcode
+ See also \l project and \l url.
\target project-variable
\section1 project
- The \c project variable provides a name for the project
- associated with the \c .qdocconf file.
+ The \c project variable provides a name for the project associated
+ with the \c .qdocconf file.
- The project's name is used to form a file name for the
- associated project's \e index file.
+ The project's name is used to form a file name for the associated
+ project's \e index file.
- \code
- project = QtMotif
- \endcode
+ \code
+ project = QtMotif
+ \endcode
- This will cause an index file called \c qtmotif.index to be
- created.
+ This will cause an index file called \c qtmotif.index to be
+ created.
- See also \l description and \l indexes.
+ See also \l description and \l indexes.
\target url-variable
\section1 url
- The \c url variable holds the base URL for the
- reference documentation associated with the current project.
-
- The URL is stored in the generated index file for the
- project. When we use the index on its own, QDoc will use
- this as the base URL when constructing links to classes,
- functions, and other things listed in the index.
-
- \code
- project = Qt
- description = Qt Reference Documentation
- url = http://qt.nokia.com/doc/4.0
+ The \c url variable holds the base URL for the reference
+ documentation associated with the current project.
- ...
- \endcode
+ The URL is stored in the generated index file for the
+ project. When we use the index on its own, QDoc will use this as
+ the base URL when constructing links to classes, functions, and
+ other things listed in the index.
- This makes sure that whenever \c qt.index is used to generate
- references to for example Qt classes, the base URL is
- \c http://qt.nokia.com/doc/4.0.
+ \code
+ project = Qt
+ description = Qt Reference Documentation
+ url = http://qt.nokia.com/doc/4.0
- See also \l indexes.
+ ...
+ \endcode
+ This makes sure that whenever \c qt.index is used to generate
+ references to for example Qt classes, the base URL is \c
+ http://qt.nokia.com/doc/4.0.
+ See also \l indexes.
\target howto
\section1 How to Support Derived Projects