summaryrefslogtreecommitdiff
path: root/api/Specification.cpp
diff options
context:
space:
mode:
authorJean-Luc Brouillet <jeanluc@google.com>2015-04-02 16:15:25 -0700
committerJean-Luc Brouillet <jeanluc@google.com>2015-04-02 16:16:52 -0700
commit4a73004df5231d188c41267fee17c566ae7c3631 (patch)
treeb6a7ec31a3231a9648e7a91db29902c8c215230c /api/Specification.cpp
parent301dc422de63135cd617546dad52e11c89fafaf7 (diff)
downloadrs-4a73004df5231d188c41267fee17c566ae7c3631.tar.gz
Add "deprecated:" flag to the spec files.
Also cleanup of the documentation found in the header and html files. Change-Id: I8a606d1af93b0fd0f912ac23aabdb73aa99233b4
Diffstat (limited to 'api/Specification.cpp')
-rw-r--r--api/Specification.cpp8
1 files changed, 6 insertions, 2 deletions
diff --git a/api/Specification.cpp b/api/Specification.cpp
index 92d14d61..fbbbc21f 100644
--- a/api/Specification.cpp
+++ b/api/Specification.cpp
@@ -214,7 +214,7 @@ void VersionInfo::scan(Scanner* scanner) {
}
}
-Definition::Definition(const std::string& name) : mName(name), mHidden(false) {
+Definition::Definition(const std::string& name) : mName(name), mDeprecated(false), mHidden(false) {
}
void Definition::scanDocumentationTags(Scanner* scanner, bool firstOccurence,
@@ -223,6 +223,10 @@ void Definition::scanDocumentationTags(Scanner* scanner, bool firstOccurence,
scanner->checkNoValue();
mHidden = true;
}
+ if (scanner->findOptionalTag("deprecated:")) {
+ mDeprecated = true;
+ mDeprecatedMessage = scanner->getValue();
+ }
if (firstOccurence) {
if (scanner->findTag("summary:")) {
mSummary = scanner->getValue();
@@ -561,7 +565,7 @@ void FunctionSpecification::scanFunctionSpecification(Scanner* scanner, SpecFile
FunctionPermutation::FunctionPermutation(Function* func, FunctionSpecification* spec,
int replacementIndexes[MAX_REPLACEABLES], Scanner* scanner)
- : mFunction(func), mReturn(nullptr), mInputCount(0), mOutputCount(0) {
+ : mReturn(nullptr), mInputCount(0), mOutputCount(0) {
// We expand the strings now to make capitalization easier. The previous code preserved
// the #n
// markers just before emitting, which made capitalization difficult.