summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2017-01-04 14:06:10 +0100
committerTopi Reiniƶ <topi.reinio@qt.io>2017-01-05 10:07:32 +0000
commita2770b85b56a5b2954c2d4995408277faaa43070 (patch)
tree5edc124f70fa7fedb662e3130a2c79a1354913b3
parentfa26283dfa36eba3e71f7c71e27d01f4a28c1d4c (diff)
Doc: QDoc manual: clean up command index
Fix typos and formatting, remove unused \span commands and remarks of items introduced 5 years ago as being 'New'. Also list the \qml command in the command index, and remove a couple of obsolete statements. Change-Id: Iaa7a81889f30e08ea8299bc0e1848c8472efa7e1 Reviewed-by: Martin Smith <martin.smith@qt.io>
-rw-r--r--src/qdoc/doc/qdoc-manual-cmdindex.qdoc13
-rw-r--r--src/qdoc/doc/qdoc-manual-contextcmds.qdoc2
-rw-r--r--src/qdoc/doc/qdoc-manual-markupcmds.qdoc26
3 files changed, 21 insertions, 20 deletions
diff --git a/src/qdoc/doc/qdoc-manual-cmdindex.qdoc b/src/qdoc/doc/qdoc-manual-cmdindex.qdoc
index 2e2a9f6d7..5d8c82142 100644
--- a/src/qdoc/doc/qdoc-manual-cmdindex.qdoc
+++ b/src/qdoc/doc/qdoc-manual-cmdindex.qdoc
@@ -41,14 +41,14 @@
\li \l {abstract-command} {\\abstract}
\li \l {annotatedlist-command} {\\annotatedlist}
\li \l {b-command} {\\b}
- \li \l {b-command} {\\bold} \span {class="newStuff"} {(deprecated, use \\b)}
+ \li \l {b-command} {\\bold} (deprecated, use \\b)
\li \l {brief-command} {\\brief}
\li \l {c-command} {\\c}
\li \l {caption-command} {\\caption}
\li \l {chapter-command} {\\chapter}
\li \l {class-command} {\\class}
\li \l {code-command} {\\code}
- \li \l {codeline-command} {\\codeline},
+ \li \l {codeline-command} {\\codeline}
\li \l {compat-command} {\\compat}
\li \l {contentspage-command} {\\contentspage}
\li \l {default-command} {\\default}
@@ -66,7 +66,7 @@
\li \l {group-command} {\\group}
\li \l {header-command} {\\header}
\li \l {headerfile-command} {\\headerfile}
- \li \l {e-command} {\\i} \span {class="newStuff"} {(deprecated, use \\e)}
+ \li \l {e-command} {\\i} (deprecated, use \\e)
\li \l {if-command} {\\if}
\li \l {image-command} {\\image}
\li \l {include-command} {\\include}
@@ -92,7 +92,7 @@
\li \l {noautolist-command} {\\noautolist}
\li \l {nonreentrant-command} {\\nonreentrant}
\li \l {note-command} {\\note}
- \li \l {li-command} {\\o} \span {class="newStuff"} {(deprecated, use \\li)}
+ \li \l {li-command} {\\o} (deprecated, use \\li)
\li \l {obsolete-command} {\\obsolete}
\li \l {oldcode-command} {\\oldcode}
@@ -107,11 +107,12 @@
\li \l {printto-command} {\\printto}
\li \l {printuntil-command} {\\printuntil}
\li \l {property-command} {\\property}
+ \li \l {qml-command} {\\qml}
\li \l {qmlabstract-command} {\\qmlabstract}
\li \l {qmlattachedproperty-command} {\\qmlattachedproperty}
\li \l {qmlattachedsignal-command} {\\qmlattachedsignal}
\li \l {qmlbasictype-command} {\\qmlbasictype}
- \li \l {qmlclass-command} {\\qmlclass} \span {class="newStuff"} {(deprecated, use \\qmltype)}
+ \li \l {qmlclass-command} {\\qmlclass} (deprecated, use \\qmltype)
\li \l {qmltype-command} {\\qmltype}
\li \l {qmlmethod-command} {\\qmlmethod}
\li \l {qmlproperty-command} {\\qmlproperty}
@@ -134,7 +135,7 @@
\li \l {skipline-command} {\\skipline}
\li \l {skipto-command} {\\skipto}
\li \l {skipuntil-command} {\\skipuntil}
- \li \l {snippet-command} {\\snippet},
+ \li \l {snippet-command} {\\snippet}
\li \l {span-command} {\\span}
\li \l {startpage-command} {\\startpage}
\li \l {sub-command} {\\sub}
diff --git a/src/qdoc/doc/qdoc-manual-contextcmds.qdoc b/src/qdoc/doc/qdoc-manual-contextcmds.qdoc
index 11b77bbdc..63d502395 100644
--- a/src/qdoc/doc/qdoc-manual-contextcmds.qdoc
+++ b/src/qdoc/doc/qdoc-manual-contextcmds.qdoc
@@ -319,7 +319,7 @@
The \\default command is for marking a QML property as the
\l {default-properties}
- {default property}. The word \span {class="newStuff"} {default} is shown in red in
+ {default property}. The word \c default is displayed in
the documentation of the property.
\code
diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
index 4f7cbf735..55b63fff4 100644
--- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
+++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
@@ -39,8 +39,8 @@
\list
\li \l {a-command} {\\a}
\li \l {annotatedlist-command} {\\annotatedlist}
- \li \l {b-command} {\\b} \span {class="newStuff"}
- \li \l {b-command} {\\bold} {(deprecated, use \\b)}
+ \li \l {b-command} {\\b}
+ \li \l {b-command} {\\bold} (deprecated, use \\b)
\li \l {brief-command} {\\brief}
\li \l {c-command} {\\c}
\li \l {caption-command} {\\caption}
@@ -49,13 +49,13 @@
\li \l {codeline-command} {\\codeline}
\li \l {div-command} {\\div}
\li \l {dots-command} {\\dots}
- \li \l {e-command} {\\e} \span {class="newStuff"}
+ \li \l {e-command} {\\e}
\li \l {else-command} {\\else}
\li \l {endif-command} {\\endif}
\li \l {footnote-command} {\\footnote}
\li \l {generatelist-command} {\\generatelist}
\li \l {header-command} {\\header}
- \li \l {e-command} {\\i} \span {class="newStuff"} {(deprecated, use \\e)}
+ \li \l {e-command} {\\i} (deprecated, use \\e)
\li \l {if-command} {\\if}
\li \l {image-command} {\\image}
\li \l {include-command} {\\include}
@@ -64,12 +64,12 @@
\li \l {keyword-command} {\\keyword}
\li \l {l-command} {\\l}
\li \l {legalese-command} {\\legalese}
- \li \l {li-command} {\\li} \span {class="newStuff"}
+ \li \l {li-command} {\\li}
\li \l {list-command} {\\list}
\li \l {meta-command} {\\meta}
\li \l {noautolist-command} {\\noautolist}
\li \l {newcode-command} {\\newcode}
- \li \l {li-command} {\\o} \span {class="newStuff"} {(deprecated, use \\li)}
+ \li \l {li-command} {\\o} (deprecated, use \\li)
\li \l {note-command} {\\note}
\li \l {oldcode-command} {\\oldcode}
\li \l {omit-command} {\\omit}
@@ -77,6 +77,7 @@
\li \l {printline-command} {\\printline}
\li \l {printto-command} {\\printto}
\li \l {printuntil-command} {\\printuntil}
+ \li \l {qml-command}{\\qml}
\li \l {quotation-command} {\\quotation}
\li \l {quotefile-command} {\\quotefile}
\li \l {quotefromfile-command} {\\quotefromfile}
@@ -98,7 +99,7 @@
\li \l {tableofcontents-command} {\\tableofcontents}
\li \l {target-command} {\\target}
\li \l {tt-command} {\\tt}
- \li \l {uicontrol-command} {\\uicontrol} {(new 25/3/2012)}
+ \li \l {uicontrol-command} {\\uicontrol}
\li \l {underline-command} {\\underline}
\li \l {raw-command} {\\unicode}
\li \l {warning-command} {\\warning}
@@ -483,7 +484,7 @@
\endquotation
\target e-command
- \section1 \\e (emphasis, italics) \span {class="newStuff"} {(new 5/3/2012)}
+ \section1 \\e (emphasis, italics)
The \\e command renders its argument in a special font, normally italics. This
command used to be called \\i, which is now deprecated. Use \e for italics.
@@ -1085,13 +1086,12 @@
\section1 \\qml
The \\qml and \\endqml commands enclose a snippet of QML source
- code. Currently, QDoc handles \\qml and \\endqml in exactly the same
- way as \\code and \\endcode.
+ code.
\code
/ *!
\qml
- import QtQuick 1.0
+ import QtQuick 2.0
Row {
Rectangle {
@@ -1112,7 +1112,7 @@
QDoc renders this as:
\qml
- import QtQuick 1.0
+ import QtQuick 2.0
Row {
Rectangle {
@@ -3985,7 +3985,7 @@
\endraw
\target raw-command
- \section1 \\raw \span {class="newStuff"} {(avoid)}
+ \section1 \\raw (avoid)
The \\raw command and the corresponding
\\endraw command delimit a block of raw mark-up language code.