summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Boddie <david.boddie@nokia.com>2011-01-21 13:24:40 (GMT)
committerDavid Boddie <david.boddie@nokia.com>2011-01-21 13:24:40 (GMT)
commit2d5d354068e18de999c0316c2356726f9fe69fca (patch)
tree56d844bb1e69cd178898c33da7cb2d1fe1ca96b4
parent425a718facbb2b4a8f9919516b98257ef98c6182 (diff)
downloadQt-2d5d354068e18de999c0316c2356726f9fe69fca.zip
Qt-2d5d354068e18de999c0316c2356726f9fe69fca.tar.gz
Qt-2d5d354068e18de999c0316c2356726f9fe69fca.tar.bz2
Doc: Updated the qdoc manual.
-rw-r--r--tools/qdoc3/doc/qdoc-manual.qdoc33
1 files changed, 21 insertions, 12 deletions
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index b557ad9..5b908d2 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -7804,20 +7804,14 @@
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.}
+ \o \bold slow (removed) \target slow
+ \o \bold {The \c slow variable previously specified whether QDoc should
+ do time-consuming processing, such as syntax highlighting.}
- By default, this setting is false.
+ This option has been replaced by the \l{syntaxhighlighing} option.
- Example:
-
- \code
- slow = true
- \endcode
-
- 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.
\row
\o \bold sourcedirs \target sourcedirs
@@ -7957,6 +7951,21 @@
\endcode
\row
+ \o \bold syntaxhighlighting \target syntaxhighlighting
+ \o \bold{The \c syntaxhighlighting variable specifies whether QDoc
+ should perform syntax highlighting on source code quoted in the
+ documentation it output.}
+
+ For example:
+
+ \code
+ syntaxhighlighting = true
+ \endcode
+
+ will enable syntax highlighting for all supported programming
+ languages.
+
+ \row
\o \bold tabsize \target tabsize
\o \bold {The \c tabsize variable defines the size of a tab
character.}