diff options
| author | Martin Smith <martin.smith@qt.io> | 2016-09-01 09:40:15 +0200 |
|---|---|---|
| committer | Martin Smith <martin.smith@qt.io> | 2017-08-10 07:32:53 +0000 |
| commit | 02de17eae61496e3b9ba78de5b8868ad94d21294 (patch) | |
| tree | 4ad0a3f8ea752922e466f3b776056b4228bb2e7b /src/qdoc/codeparser.cpp | |
| parent | c3afec5a9adbed05c780dcfff5de0e76f287cb79 (diff) | |
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/codeparser.cpp')
| -rw-r--r-- | src/qdoc/codeparser.cpp | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/src/qdoc/codeparser.cpp b/src/qdoc/codeparser.cpp index 83d2ddc4d..c344ad763 100644 --- a/src/qdoc/codeparser.cpp +++ b/src/qdoc/codeparser.cpp @@ -354,6 +354,21 @@ void CodeParser::setLink(Node* node, Node::LinkType linkType, const QString& arg } /*! + \brief Test for whether a doc comment warrants warnings. + + Returns true if qdoc should report that it has found something + wrong with the qdoc comment in \a doc. Sometimes, qdoc should + not report the warning, for example, when the comment contains + the \c internal command, which normally means qdoc will not use + the comment in the documentation anyway, so there is no point + in reporting warnings about it. + */ +bool CodeParser::isWorthWarningAbout(const Doc &doc) +{ + return (showInternal_ || !doc.metaCommandsUsed().contains(QStringLiteral("internal"))); +} + +/*! Returns \c true if the file being parsed is a .h file. */ bool CodeParser::isParsingH() const |