diff options
author | Martin Smith <martin.smith@nokia.com> | 2011-02-24 10:48:32 (GMT) |
---|---|---|
committer | Martin Smith <martin.smith@nokia.com> | 2011-02-24 10:48:32 (GMT) |
commit | e51fda7db531628b54297ae020dda4a5f962d394 (patch) | |
tree | 846fa261f80459529235e890ed897cf6186e9351 /tools/qdoc3/doc/qdoc-manual.qdoc | |
parent | 66aba9ad196c24d6844e39901bf152d0951ccfb7 (diff) | |
parent | c881e33e7e510204fabd061dac08a00b10b432fb (diff) | |
download | Qt-e51fda7db531628b54297ae020dda4a5f962d394.zip Qt-e51fda7db531628b54297ae020dda4a5f962d394.tar.gz Qt-e51fda7db531628b54297ae020dda4a5f962d394.tar.bz2 |
Merge branch 'mimir' of git@scm.dev.nokia.troll.no:qt/qt-doc-team into mimir
Diffstat (limited to 'tools/qdoc3/doc/qdoc-manual.qdoc')
-rw-r--r-- | tools/qdoc3/doc/qdoc-manual.qdoc | 45 |
1 files changed, 39 insertions, 6 deletions
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc index a214b9c..6b3014c 100644 --- a/tools/qdoc3/doc/qdoc-manual.qdoc +++ b/tools/qdoc3/doc/qdoc-manual.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** @@ -7296,6 +7296,25 @@ 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. + + For example: + + \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 @@ -7316,12 +7335,10 @@ Example: - \code - slow = true - \endcode + This option has been replaced by the \l{syntaxhighlighing} option. - Another way to turn on "slowness" is to invoke QDoc with the - \c -slow command-line option. + For compatibility, the \c -slow command-line option has been + retained. This has the effect of enabling syntax highlighting. \target sourcedirs-variable @@ -7472,6 +7489,22 @@ 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. + + For example: + + \code + syntaxhighlighting = true + \endcode + + will enable syntax highlighting for all supported programming + languages. + \target tabsize-variable \section1 tabsize |