summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Koehne <kai.koehne@qt.io>2020-11-16 07:58:50 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2020-11-17 10:43:41 +0000
commit6f90d0a98c7af008bc5675bd6e79967fde124d21 (patch)
tree2d9fc86f1548e1f9e440f41e4182f6d2327f3b97
parent02eed75d1661371fb76b496dfd08cbd198737b35 (diff)
Doc: Document attribution argument
Attribution pages got introduced in commit d3f3e98ee. Also order the arguments alphabetically. Change-Id: I14d54067b803bf6a788676a45fec7969486187be Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> (cherry picked from commit 3d97baa9535a7dc4dedd883d1c1fa2a2a0e6d1c6) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/qdoc/doc/qdoc-manual-topiccmds.qdoc14
1 files changed, 8 insertions, 6 deletions
diff --git a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
index 0837648b7..7d906ce64 100644
--- a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
+++ b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
@@ -930,22 +930,24 @@
\list
+ \li api - This is the type of page used for C++ class references and
+ QML type references. You should never use this one for the pages
+ you write, because this one is reserved for QDoc.
+
+ \li attribution - A page describing (code) attributions.
+
+ \li example - A page that describes a working example.
+
\li faq - A frequently asked question.
\li howto - A user guide on how to use some components of the
software.
- \li example - A page that describes a working example.
-
\li overview - For text pages that provide an overview of some
important subject.
\li tutorial - For text pages that are part of a tutorial.
- \li api - This is the type of page used for C++ class references and
- QML type references. You should never use this one for the pages
- you write, because this one is reserved for QDoc.
-
\endlist
The page title is set using the \l {title-command} {\\title}