diff options
author | Paul Wicking <paul.wicking@qt.io> | 2021-06-08 10:59:18 +0200 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2021-06-21 11:50:54 +0000 |
commit | 6978efebbfbeecae5d963883318e871637f12c83 (patch) | |
tree | 6daaea14a898f2ea1971b8d6b9a1c1fc52301995 | |
parent | b5a14d45a7f89300a8d8b76d72ec34428a491914 (diff) |
Doc: Fix warnings in QDoc manual
Change-Id: Ide38580a53eb92194fe5c0f51b36d40991184472
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
(cherry picked from commit 3cb242463f34065e220c31c6ae6fbf3dd1e09be4)
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r-- | src/qdoc/doc/qdoc-manual-contextcmds.qdoc | 2 | ||||
-rw-r--r-- | src/qdoc/doc/qdoc-warnings.qdoc | 7 |
2 files changed, 5 insertions, 4 deletions
diff --git a/src/qdoc/doc/qdoc-manual-contextcmds.qdoc b/src/qdoc/doc/qdoc-manual-contextcmds.qdoc index 020e178d2..e55d7b7ff 100644 --- a/src/qdoc/doc/qdoc-manual-contextcmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-contextcmds.qdoc @@ -307,7 +307,7 @@ It may be removed in a future version of QDoc. Use the \\deprecated command instead. - \sa \l{deprecated-command}{\\deprecated} + \sa {deprecated-command}{\\deprecated} \target deprecated-command \section1 \\deprecated diff --git a/src/qdoc/doc/qdoc-warnings.qdoc b/src/qdoc/doc/qdoc-warnings.qdoc index a1a9650d4..b57c2a5e0 100644 --- a/src/qdoc/doc/qdoc-warnings.qdoc +++ b/src/qdoc/doc/qdoc-warnings.qdoc @@ -54,7 +54,7 @@ \li The name (or, for functions, where specified, signature) used where it is documented not matching the name used in its declaration. - \li The link target being marked as \l {inmodule-internal}{\\internal} when the linking + \li The link target being marked as \l {internal-command}{\\internal} when the linking text was not. \endlist @@ -338,7 +338,7 @@ \section1 Missing format name after \\raw - The \l {raw-command}{\\raw} command and the corresponding \l {endraw-command}{\\endraw} + The \l {raw-command}{\\raw} command and the corresponding \l {raw-command}{\\endraw} command delimit a block of raw mark-up language code. The \\raw command must be followed by the format name. For now, this can only be HTML. @@ -442,7 +442,7 @@ \section1 Unexpected <end_command> - This warning is issued if, for example, you have an \l {endlist-command}{\\endlist} without + This warning is issued if, for example, you have an \l {list-command}{\\endlist} without a preceding \l {list-command}{\\list}. It applies to all commands that come in pairs (e.g. startFoo/endFoo). @@ -770,3 +770,4 @@ \endcode QDoc will issue this warning if a certain title is used in more than one page. +*/ |