diff options
Diffstat (limited to 'src/qdoc/doc/qdoc-manual-qdocconf.qdoc')
| -rw-r--r-- | src/qdoc/doc/qdoc-manual-qdocconf.qdoc | 54 |
1 files changed, 11 insertions, 43 deletions
diff --git a/src/qdoc/doc/qdoc-manual-qdocconf.qdoc b/src/qdoc/doc/qdoc-manual-qdocconf.qdoc index 6d26de344..ef92cc99e 100644 --- a/src/qdoc/doc/qdoc-manual-qdocconf.qdoc +++ b/src/qdoc/doc/qdoc-manual-qdocconf.qdoc @@ -91,7 +91,6 @@ \li \l {Cpp.ignoretokens-variable} {Cpp.ignoretokens} \li \l {defines-variable} {defines} \li \l {depends-variable} {depends} - \li \l {edition-variable} {edition} \li \l {exampledirs-variable} {exampledirs} \li \l {examples-variable} {examples} \li \l {examples.fileextensions-variable} {examples.fileextensions} @@ -244,10 +243,10 @@ line using the -D option. For example: \badcode - currentdirectory$ qdoc -Dconsoleedition qtgui.qdocconf + currentdirectory$ qdoc -Dqtforpython qtgui.qdocconf \endcode - In this case the -D option ensures that the \c consoleedition + In this case the -D option ensures that the \c qtforpython preprocessor symbol is defined when QDoc processes the source files defined in the qtgui.qdocconf file. @@ -305,37 +304,6 @@ See also \l indexes, \l project, and \l url. - \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. - - 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: - - \badcode - 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: - - \badcode - \generatelist{classesbyedition Console} - \endcode - \target exampledirs-variable \section1 exampledirs @@ -422,7 +390,7 @@ \section1 examples.fileextensions The \c examples.fileextensions variable specifies the file - extensions that qdoc will look for when collecting example files + 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 @@ -441,7 +409,7 @@ \section1 excludedirs The \c excludedirs variable is for listing directories that should \e{not} - be processed by qdoc, even if the same directories are included by the + be processed by QDoc, even if the same directories are included by the \l {sourcedirs-variable} {sourcedirs} or \l {headerdirs-variable} {headerdirs} variables. @@ -454,7 +422,7 @@ When executed, QDoc will exclude the listed directories from further consideration. Files in these directories will not be - read by qdoc. + read by QDoc. See also \l {excludefiles-variable} {excludefiles}. @@ -462,7 +430,7 @@ \section1 excludefiles The \c excludefiles variable allows you to specify individual files - that should \e{not} be processed by qdoc. + that should \e{not} be processed by QDoc. \badcode excludefiles += $QT_CORE_SOURCES/../../src/widgets/kernel/qwidget.h \ @@ -940,7 +908,7 @@ \section1 naturallanguage The \c naturallanguage variable specifies the natural language - used for the documentation generated by qdoc. + used for the documentation generated by QDoc. \badcode naturallanguage = zh-Hans @@ -949,7 +917,7 @@ By default, the natural language is \c en for compatibility with legacy documentation. - qdoc will add the natural language information to the HTML it + 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}, @@ -1043,7 +1011,7 @@ \section1 outputencoding The \c outputencoding variable specifies the encoding used for the - documentation generated by qdoc. + documentation generated by QDoc. \badcode outputencoding = UTF-8 @@ -1055,7 +1023,7 @@ 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 + 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 @@ -1188,7 +1156,7 @@ 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 + 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 |