summaryrefslogtreecommitdiff
path: root/src/qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/qdoc')
-rw-r--r--src/qdoc/qdoc/doc/qdoc-warnings.qdoc11
1 files changed, 5 insertions, 6 deletions
diff --git a/src/qdoc/qdoc/doc/qdoc-warnings.qdoc b/src/qdoc/qdoc/doc/qdoc-warnings.qdoc
index 518f1255c..0c1ad2cc8 100644
--- a/src/qdoc/qdoc/doc/qdoc-warnings.qdoc
+++ b/src/qdoc/qdoc/doc/qdoc-warnings.qdoc
@@ -348,12 +348,11 @@
\section1 Unknown command <name>
- When a QDoc comment uses a backslash followed by a token that is not
- a QDoc built-in command and has not been defined as a custom command
- using \l {alias-variable}{\\alias} or \l {macro-variable}{macro}, QDoc produces this
- warning. Check the spelling of the command name and look to see if
- your QDoc configuration has neglected to include whatever would have
- defined it, if it is a custom command.
+ When a QDoc comment uses a backslash followed by a token that is not a QDoc
+ built-in command and has not been defined as a custom command
+ \l {macro-variable}{macro}, QDoc produces this warning. Check the spelling
+ of the command name, and check whether your QDoc configuration doesn't
+ include whatever would have defined it, if it's a custom command.
This may also be produced due to code being quoted in the QDoc comment,
for example the author may have referred to the C string termination