1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-10-18 18:42:46 +02:00

[llvm-cov] Flesh out some doxygen comments, NFC

llvm-svn: 273772
This commit is contained in:
Vedant Kumar 2016-06-25 05:48:54 +00:00
parent e117e10095
commit 1579f6c57d
4 changed files with 20 additions and 16 deletions

View File

@ -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"

View File

@ -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;

View File

@ -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"

View File

@ -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;