diff options
author | Vedant Kumar <vsk@apple.com> | 2016-06-25 05:48:54 +0000 |
---|---|---|
committer | Vedant Kumar <vsk@apple.com> | 2016-06-25 05:48:54 +0000 |
commit | a6154f98d5ff6d824e925e7773f41f05e9f32d2f (patch) | |
tree | 000582c9991c64dd59a272a613349051a5316549 | |
parent | 49b4592c1a0aa1d71ef2c34adee9c08fb23c127c (diff) |
[llvm-cov] Flesh out some doxygen comments, NFC
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@273772 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r-- | tools/llvm-cov/SourceCoverageView.cpp | 6 | ||||
-rw-r--r-- | tools/llvm-cov/SourceCoverageView.h | 17 | ||||
-rw-r--r-- | tools/llvm-cov/SourceCoverageViewText.cpp | 6 | ||||
-rw-r--r-- | tools/llvm-cov/SourceCoverageViewText.h | 7 |
4 files changed, 20 insertions, 16 deletions
diff --git a/tools/llvm-cov/SourceCoverageView.cpp b/tools/llvm-cov/SourceCoverageView.cpp index c393ad42f4c..285767e322c 100644 --- a/tools/llvm-cov/SourceCoverageView.cpp +++ b/tools/llvm-cov/SourceCoverageView.cpp @@ -6,9 +6,9 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This class implements rendering for code coverage of source code. -// +/// +/// \file This class implements rendering for code coverage of source code. +/// //===----------------------------------------------------------------------===// #include "SourceCoverageView.h" diff --git a/tools/llvm-cov/SourceCoverageView.h b/tools/llvm-cov/SourceCoverageView.h index ef237d8e885..82822ca9ee3 100644 --- a/tools/llvm-cov/SourceCoverageView.h +++ b/tools/llvm-cov/SourceCoverageView.h @@ -6,9 +6,9 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This class implements rendering for code coverage of source code. -// +/// +/// \file This class implements rendering for code coverage of source code. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_COV_SOURCECOVERAGEVIEW_H @@ -24,7 +24,7 @@ namespace llvm { class SourceCoverageView; -/// \brief A view that represents a macro or include expansion +/// \brief A view that represents a macro or include expansion. struct ExpansionView { coverage::CounterMappingRegion Region; std::unique_ptr<SourceCoverageView> View; @@ -49,7 +49,7 @@ struct ExpansionView { } }; -/// \brief A view that represents a function instantiation +/// \brief A view that represents a function instantiation. struct InstantiationView { StringRef FunctionName; unsigned Line; @@ -98,8 +98,11 @@ struct LineCoverageStats { } }; -/// \brief A code coverage view of a specific source file. -/// It can have embedded coverage views. +/// \brief A code coverage view of a source file or function. +/// +/// A source coverage view and its nested sub-views form a file-oriented +/// representation of code coverage data. This view can be printed out by a +/// renderer which implements the Rendering Interface. class SourceCoverageView { /// A function or file name. StringRef SourceName; diff --git a/tools/llvm-cov/SourceCoverageViewText.cpp b/tools/llvm-cov/SourceCoverageViewText.cpp index 50c87607ed0..c1f281ce71d 100644 --- a/tools/llvm-cov/SourceCoverageViewText.cpp +++ b/tools/llvm-cov/SourceCoverageViewText.cpp @@ -6,9 +6,9 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file implements the text-based coverage renderer. -// +/// +/// \file This file implements the text-based coverage renderer. +/// //===----------------------------------------------------------------------===// #include "SourceCoverageViewText.h" diff --git a/tools/llvm-cov/SourceCoverageViewText.h b/tools/llvm-cov/SourceCoverageViewText.h index f383afcd5a7..6753a59c35d 100644 --- a/tools/llvm-cov/SourceCoverageViewText.h +++ b/tools/llvm-cov/SourceCoverageViewText.h @@ -6,9 +6,9 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the interface to the text-based coverage renderer. -// +/// +/// \file This file defines the interface to the text-based coverage renderer. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_COV_SOURCECOVERAGEVIEWTEXT_H @@ -18,6 +18,7 @@ namespace llvm { +/// \brief A code coverage view which supports text-based rendering. class SourceCoverageViewText : public SourceCoverageView { void renderSourceName(raw_ostream &OS) override; |