From bfbf29cfad1d043ca30c93eca2ff64b292673acb Mon Sep 17 00:00:00 2001 From: Paul Wicking Date: Thu, 27 Apr 2023 13:32:08 +0200 Subject: Doc: Fix QDoc warning in QDoc manual MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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ö --- src/qdoc/qdoc/doc/qdoc-warnings.qdoc | 11 +++++------ 1 file 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 - 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 -- cgit v1.2.1