summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@nokia.com>2011-01-28 09:19:07 (GMT)
committerMartin Smith <martin.smith@nokia.com>2011-01-28 09:19:07 (GMT)
commit71a35851a6206956846b52c264ca1e8f97e180a5 (patch)
treef77b27e21ce8a87788fd90c20687be8df2e35cae
parent046cf4d3de6cca9c7b3f734ad035b6cf6fcbef4f (diff)
downloadQt-71a35851a6206956846b52c264ca1e8f97e180a5.zip
Qt-71a35851a6206956846b52c264ca1e8f97e180a5.tar.gz
Qt-71a35851a6206956846b52c264ca1e8f97e180a5.tar.bz2
qdoc: Updated the qdoc manual.
Modified the description of the \raw command. IKt is to be avoided, so I showed how to do the example of \raw ... \endraw using the qdoc commands \tt and \span.
-rw-r--r--tools/qdoc3/doc/qdoc-manual.qdoc42
1 files changed, 30 insertions, 12 deletions
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 3036af8..0c303c1 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -4584,15 +4584,16 @@
\raw HTML
<style type="text/css" id="colorstyles">
- #blue { background-color: #0000ff; color: #ffffff }
- #darkBlue { background-color: #000080; color: #ffffff }
- #cyan { background-color: #00ffff; color: #000000 }
+ #color-blue { background-color: #0000ff; color: #ffffff }
+ #color-darkBlue { background-color: #000080; color: #ffffff }
+ #color-cyan { background-color: #00ffff; color: #000000 }
</style>
<p>
- <tt id="blue">Blue(#0000ff)</tt>,
- <tt id="darkBlue">dark blue(#000080)</tt> and
- <tt id="cyan">cyan(#00ffff)</tt>.
+ <tt id="color-blue">Blue(#0000ff)</tt>,
+ <tt id="color-darkBlue">dark blue(#000080)</tt> and
+ <tt id="color-cyan">cyan(#00ffff)</tt>.
+ </p>
\endraw
* /
\endcode
@@ -4604,18 +4605,35 @@
\raw HTML
<style type="text/css" id="colorstyles">
- #blue { background-color: #0000ff; color: #ffffff }
- #darkBlue { background-color: #000080; color: #ffffff }
- #cyan { background-color: #00ffff; color: #000000 }
+ #color-blue { background-color: #0000ff; color: #ffffff }
+ #color-darkBlue { background-color: #000080; color: #ffffff }
+ #color-cyan { background-color: #00ffff; color: #000000 }
</style>
<p>
- <tt id="blue">Blue(#0000ff)</tt>,
- <tt id="darkBlue">dark blue(#000080)</tt> and
- <tt id="cyan">cyan(#00ffff)</tt>.
+ <tt id="color-blue">Blue(#0000ff)</tt>,
+ <tt id="color-darkBlue">dark blue(#000080)</tt> and
+ <tt id="color-cyan">cyan(#00ffff)</tt>.
+ </p>
\endraw
\endquotation
+ \note But you can achieve the exact same thing using qdoc
+ commands. In this case, all you have to do is include the
+ color styles in your style.css file. Then you can write:
+
+ \code
+ \tt {\span {id="color-blue"}{Blue(#0000ff)}},
+ \tt {\span {id="color-darkBlue"}{dark blue(#000080)}} and
+ \tt {\span {id="color-cyan"}{cyan(#00ffff)}}.
+ \endcode
+
+ ...which is rendered again as:
+
+ \tt {\span {id="color-blue"}{Blue(#0000ff)}},
+ \tt {\span {id="color-darkBlue"}{dark blue(#000080)}} and
+ \tt {\span {id="color-cyan"}{cyan(#00ffff)}}.
+
\row
\o \bold \\unicode \target unicode
\o \bold {The \\unicode command allows you to insert an