summaryrefslogtreecommitdiffstats
path: root/llvm/tools/llvm-cov/CoverageExporterJson.h
diff options
context:
space:
mode:
authorAdrian Prantl <aprantl@apple.com>2018-05-01 15:54:18 +0000
committerAdrian Prantl <aprantl@apple.com>2018-05-01 15:54:18 +0000
commit5f8f34e459b60efb332337e7cfe902a7cabe4096 (patch)
treeb80a88887ea8331179e6294f1135d38a66ec28ce /llvm/tools/llvm-cov/CoverageExporterJson.h
parent5727011fd552d87351c6229dc0337114a0269848 (diff)
downloadbcm5719-llvm-5f8f34e459b60efb332337e7cfe902a7cabe4096.tar.gz
bcm5719-llvm-5f8f34e459b60efb332337e7cfe902a7cabe4096.zip
Remove \brief commands from doxygen comments.
We've been running doxygen with the autobrief option for a couple of years now. This makes the \brief markers into our comments redundant. Since they are a visual distraction and we don't want to encourage more \brief markers in new code either, this patch removes them all. Patch produced by for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done Differential Revision: https://reviews.llvm.org/D46290 llvm-svn: 331272
Diffstat (limited to 'llvm/tools/llvm-cov/CoverageExporterJson.h')
-rw-r--r--llvm/tools/llvm-cov/CoverageExporterJson.h46
1 files changed, 23 insertions, 23 deletions
diff --git a/llvm/tools/llvm-cov/CoverageExporterJson.h b/llvm/tools/llvm-cov/CoverageExporterJson.h
index afab8a89e29..f88dffa0ebe 100644
--- a/llvm/tools/llvm-cov/CoverageExporterJson.h
+++ b/llvm/tools/llvm-cov/CoverageExporterJson.h
@@ -20,28 +20,28 @@
namespace llvm {
class CoverageExporterJson : public CoverageExporter {
- /// \brief States that the JSON rendering machine can be in.
+ /// States that the JSON rendering machine can be in.
enum JsonState { None, NonEmptyElement, EmptyElement };
- /// \brief Tracks state of the JSON output.
+ /// Tracks state of the JSON output.
std::stack<JsonState> State;
- /// \brief Emit a serialized scalar.
+ /// Emit a serialized scalar.
void emitSerialized(const int64_t Value);
- /// \brief Emit a serialized string.
+ /// Emit a serialized string.
void emitSerialized(const std::string &Value);
- /// \brief Emit a comma if there is a previous element to delimit.
+ /// Emit a comma if there is a previous element to delimit.
void emitComma();
- /// \brief Emit a starting dictionary/object character.
+ /// Emit a starting dictionary/object character.
void emitDictStart();
- /// \brief Emit a dictionary/object key but no value.
+ /// Emit a dictionary/object key but no value.
void emitDictKey(const std::string &Key);
- /// \brief Emit a dictionary/object key/value pair.
+ /// Emit a dictionary/object key/value pair.
template <typename V>
void emitDictElement(const std::string &Key, const V &Value) {
emitComma();
@@ -50,60 +50,60 @@ class CoverageExporterJson : public CoverageExporter {
emitSerialized(Value);
}
- /// \brief Emit a closing dictionary/object character.
+ /// Emit a closing dictionary/object character.
void emitDictEnd();
- /// \brief Emit a starting array character.
+ /// Emit a starting array character.
void emitArrayStart();
- /// \brief Emit an array element.
+ /// Emit an array element.
template <typename V> void emitArrayElement(const V &Value) {
emitComma();
emitSerialized(Value);
}
- /// \brief emit a closing array character.
+ /// emit a closing array character.
void emitArrayEnd();
- /// \brief Render an array of all the given functions.
+ /// Render an array of all the given functions.
void renderFunctions(
const iterator_range<coverage::FunctionRecordIterator> &Functions);
- /// \brief Render an array of all the source files, also pass back a Summary.
+ /// Render an array of all the source files, also pass back a Summary.
void renderFiles(ArrayRef<std::string> SourceFiles,
ArrayRef<FileCoverageSummary> FileReports);
- /// \brief Render a single file.
+ /// Render a single file.
void renderFile(const std::string &Filename,
const FileCoverageSummary &FileReport);
- /// \brief Render summary for a single file.
+ /// Render summary for a single file.
void renderFileCoverage(const coverage::CoverageData &FileCoverage,
const FileCoverageSummary &FileReport);
- /// \brief Render a CoverageSegment.
+ /// Render a CoverageSegment.
void renderSegment(const coverage::CoverageSegment &Segment);
- /// \brief Render an ExpansionRecord.
+ /// Render an ExpansionRecord.
void renderExpansion(const coverage::ExpansionRecord &Expansion);
- /// \brief Render a list of CountedRegions.
+ /// Render a list of CountedRegions.
void renderRegions(ArrayRef<coverage::CountedRegion> Regions);
- /// \brief Render a single CountedRegion.
+ /// Render a single CountedRegion.
void renderRegion(const coverage::CountedRegion &Region);
- /// \brief Render a FileCoverageSummary.
+ /// Render a FileCoverageSummary.
void renderSummary(const FileCoverageSummary &Summary);
public:
CoverageExporterJson(const coverage::CoverageMapping &CoverageMapping,
const CoverageViewOptions &Options, raw_ostream &OS);
- /// \brief Render the CoverageMapping object.
+ /// Render the CoverageMapping object.
void renderRoot(const CoverageFilters &IgnoreFilenameFilters) override;
- /// \brief Render the CoverageMapping object for specified source files.
+ /// Render the CoverageMapping object for specified source files.
void renderRoot(const std::vector<std::string> &SourceFiles) override;
};
OpenPOWER on IntegriCloud