summaryrefslogtreecommitdiff
path: root/src/qdoc/clangcodeparser.cpp
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@qt.io>2016-09-01 09:40:15 +0200
committerMartin Smith <martin.smith@qt.io>2017-08-10 07:32:53 +0000
commit02de17eae61496e3b9ba78de5b8868ad94d21294 (patch)
tree4ad0a3f8ea752922e466f3b776056b4228bb2e7b /src/qdoc/clangcodeparser.cpp
parentc3afec5a9adbed05c780dcfff5de0e76f287cb79 (diff)
downloadqttools-02de17eae61496e3b9ba78de5b8868ad94d21294.tar.gz
qdoc: Don't report error for things marked \internal
This change allows qdoc to avoid printing warnings about a qdoc comment, if the comment contains the \internal command. In these cases, the comment will not be used in the documentation, so there is no point reporting warnings about it. However, if the showinternal option is used, warnings about comments marked internal are printed anyway. Change-Id: Idcb329958681523c79e9f6a3a144ae26d44a6906 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/qdoc/clangcodeparser.cpp')
-rw-r--r--src/qdoc/clangcodeparser.cpp2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/qdoc/clangcodeparser.cpp b/src/qdoc/clangcodeparser.cpp
index ee7897060..ccab4a08d 100644
--- a/src/qdoc/clangcodeparser.cpp
+++ b/src/qdoc/clangcodeparser.cpp
@@ -1050,7 +1050,7 @@ void ClangCodeParser::parseSourceFile(const Location& /*location*/, const QStrin
if (n) {
nodes.append(n);
docs.append(doc);
- } else {
+ } else if (CodeParser::isWorthWarningAbout(doc)) {
doc.location().warning(tr("Cannot tie this documentation to anything"),
tr("I found a /*! ... */ comment, but there was no "
"topic command (e.g., '\\%1', '\\%2') in the "