diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2021-05-05 23:27:06 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2021-05-10 11:09:35 +0200 |
| commit | ae369522c03a7c0f22a1894c740f78f8afa4989b (patch) | |
| tree | 5449e5e27948c35309ee6eb780ad3d8fcbf5c0a5 /src/qdoc/cppcodeparser.cpp | |
| parent | 67f282f795ce15dc561a95a5082569ab018ab7d8 (diff) | |
| download | qttools-ae369522c03a7c0f22a1894c740f78f8afa4989b.tar.gz | |
qdoc: Remove Node::Obsolete status
QDoc had two commands for the same purpose, \obsolete and \deprecated.
As 'deprecated' describes the status better, as in, something that is
subject to being removed from the public API, document only the
latter. Keep \obsolete for now for backward compatibility.
.index file recognize the "obsolete" attribute still for backward
compatibility, converting to "deprecated".
[ChangeLog][qdoc] Replaced \obsolete command in favor of \deprecated
as it's a more accurate description of the intended status.
Task-number: QTBUG-58249
Change-Id: I3d311ebf7b4a3e8a23fa85e4efcf60965cf12a13
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/qdoc/cppcodeparser.cpp')
| -rw-r--r-- | src/qdoc/cppcodeparser.cpp | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/qdoc/cppcodeparser.cpp b/src/qdoc/cppcodeparser.cpp index cdb3041d4..53fe4decc 100644 --- a/src/qdoc/cppcodeparser.cpp +++ b/src/qdoc/cppcodeparser.cpp @@ -621,7 +621,7 @@ void CppCodeParser::processMetaCommand(const Doc &doc, const QString &command, if (node->isQmlType() || node->isJsType()) node->setAbstract(true); } else if (command == COMMAND_DEPRECATED) { - node->setStatus(Node::Obsolete); + node->setStatus(Node::Deprecated); } else if (command == COMMAND_INGROUP || command == COMMAND_INPUBLICGROUP) { // Note: \ingroup and \inpublicgroup are the same (and now recognized as such). qdb_->addToGroup(arg, node); @@ -632,7 +632,7 @@ void CppCodeParser::processMetaCommand(const Doc &doc, const QString &command, } else if (command == COMMAND_INJSMODULE) { qdb_->addToJsModule(arg, node); } else if (command == COMMAND_OBSOLETE) { - node->setStatus(Node::Obsolete); + node->setStatus(Node::Deprecated); } else if (command == COMMAND_NONREENTRANT) { node->setThreadSafeness(Node::NonReentrant); } else if (command == COMMAND_PRELIMINARY) { |