diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2023-04-27 13:32:08 +0200 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2023-04-27 13:55:55 +0200 |
| commit | bfbf29cfad1d043ca30c93eca2ff64b292673acb (patch) | |
| tree | 108e4b37d44d5ff8a1da397c0273520e7d426338 | |
| parent | 90147027312b88cae1fd0f432ad6c8fd73426ce6 (diff) | |
| download | qttools-bfbf29cfad1d043ca30c93eca2ff64b292673acb.tar.gz | |
Doc: Fix QDoc warning in QDoc manual
A recent change removed the \alias command from QDoc,
and failed to remove a link to it from the QDoc warnings
documentation. This patch remedies that mistake.
Change-Id: Ia2ef4d095fc548e754312317b4b07f006ccc5a59
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
| -rw-r--r-- | src/qdoc/qdoc/doc/qdoc-warnings.qdoc | 11 |
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 |