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
diff --git a/llvm/tools/llvm-mca/Backend.h b/llvm/tools/llvm-mca/Backend.h
index c21da1f..d294b61 100644
--- a/llvm/tools/llvm-mca/Backend.h
+++ b/llvm/tools/llvm-mca/Backend.h
@@ -26,7 +26,7 @@
class HWInstructionEvent;
class HWStallEvent;
-/// \brief An out of order backend for a specific subtarget.
+/// An out of order backend for a specific subtarget.
///
/// It emulates an out-of-order execution of instructions. Instructions are
/// fetched from a MCInst sequence managed by an object of class SourceMgr.
diff --git a/llvm/tools/llvm-mca/BackendPrinter.h b/llvm/tools/llvm-mca/BackendPrinter.h
index d159a95..e367554 100644
--- a/llvm/tools/llvm-mca/BackendPrinter.h
+++ b/llvm/tools/llvm-mca/BackendPrinter.h
@@ -26,7 +26,7 @@
namespace mca {
-/// \brief A printer class that knows how to collects statistics on the
+/// A printer class that knows how to collects statistics on the
/// code analyzed by the llvm-mca tool.
///
/// This class knows how to print out the analysis information collected
diff --git a/llvm/tools/llvm-mca/CodeRegion.h b/llvm/tools/llvm-mca/CodeRegion.h
index 6dc3f01..7f0025e 100644
--- a/llvm/tools/llvm-mca/CodeRegion.h
+++ b/llvm/tools/llvm-mca/CodeRegion.h
@@ -42,7 +42,7 @@
namespace mca {
-/// \brief A region of assembly code.
+/// A region of assembly code.
///
/// It identifies a sequence of machine instructions.
class CodeRegion {
diff --git a/llvm/tools/llvm-mca/Dispatch.h b/llvm/tools/llvm-mca/Dispatch.h
index c08515d..146cfc0 100644
--- a/llvm/tools/llvm-mca/Dispatch.h
+++ b/llvm/tools/llvm-mca/Dispatch.h
@@ -28,7 +28,7 @@
class Scheduler;
class Backend;
-/// \brief Manages hardware register files, and tracks data dependencies
+/// Manages hardware register files, and tracks data dependencies
/// between registers.
class RegisterFile {
const llvm::MCRegisterInfo &MRI;
@@ -155,7 +155,7 @@
#endif
};
-/// \brief tracks which instructions are in-flight (i.e. dispatched but not
+/// tracks which instructions are in-flight (i.e. dispatched but not
/// retired) in the OoO backend.
///
/// This class checks on every cycle if/which instructions can be retired.
@@ -217,7 +217,7 @@
#endif
};
-// \brief Implements the hardware dispatch logic.
+// Implements the hardware dispatch logic.
//
// This class is responsible for the dispatch stage, in which instructions are
// dispatched in groups to the Scheduler. An instruction can be dispatched if
diff --git a/llvm/tools/llvm-mca/InstrBuilder.h b/llvm/tools/llvm-mca/InstrBuilder.h
index a3b7001..30af1bf 100644
--- a/llvm/tools/llvm-mca/InstrBuilder.h
+++ b/llvm/tools/llvm-mca/InstrBuilder.h
@@ -24,7 +24,7 @@
class DispatchUnit;
-/// \brief A builder class that knows how to construct Instruction objects.
+/// A builder class that knows how to construct Instruction objects.
///
/// Every llvm-mca Instruction is described by an object of class InstrDesc.
/// An InstrDesc describes which registers are read/written by the instruction,
diff --git a/llvm/tools/llvm-mca/Instruction.h b/llvm/tools/llvm-mca/Instruction.h
index 59134bc..21fec94 100644
--- a/llvm/tools/llvm-mca/Instruction.h
+++ b/llvm/tools/llvm-mca/Instruction.h
@@ -30,7 +30,7 @@
constexpr int UNKNOWN_CYCLES = -512;
-/// \brief A register write descriptor.
+/// A register write descriptor.
struct WriteDescriptor {
// Operand index. -1 if this is an implicit write.
int OpIndex;
@@ -59,7 +59,7 @@
bool IsOptionalDef;
};
-/// \brief A register read descriptor.
+/// A register read descriptor.
struct ReadDescriptor {
// A MCOperand index. This is used by the Dispatch logic to identify register
// reads. This field defaults to -1 if this is an implicit read.
@@ -79,7 +79,7 @@
bool HasReadAdvanceEntries;
};
-/// \brief Tracks uses of a register definition (e.g. register write).
+/// Tracks uses of a register definition (e.g. register write).
///
/// Each implicit/explicit register write is associated with an instance of
/// this class. A WriteState object tracks the dependent users of a
@@ -128,7 +128,7 @@
#endif
};
-/// \brief Tracks register operand latency in cycles.
+/// Tracks register operand latency in cycles.
///
/// A read may be dependent on more than one write. This occurs when some
/// writes only partially update the register associated to this read.
@@ -160,7 +160,7 @@
void setDependentWrites(unsigned Writes) { DependentWrites = Writes; }
};
-/// \brief A sequence of cycles.
+/// A sequence of cycles.
///
/// This class can be used as a building block to construct ranges of cycles.
class CycleSegment {
@@ -205,7 +205,7 @@
void setReserved() { Reserved = true; }
};
-/// \brief Helper used by class InstrDesc to describe how hardware resources
+/// Helper used by class InstrDesc to describe how hardware resources
/// are used.
///
/// This class describes how many resource units of a specific resource kind
@@ -220,7 +220,7 @@
void setReserved() { CS.setReserved(); }
};
-/// \brief An instruction descriptor
+/// An instruction descriptor
struct InstrDesc {
std::vector<WriteDescriptor> Writes; // Implicit writes are at the end.
std::vector<ReadDescriptor> Reads; // Implicit reads are at the end.
diff --git a/llvm/tools/llvm-mca/InstructionInfoView.h b/llvm/tools/llvm-mca/InstructionInfoView.h
index 85d0644..0770ae3 100644
--- a/llvm/tools/llvm-mca/InstructionInfoView.h
+++ b/llvm/tools/llvm-mca/InstructionInfoView.h
@@ -46,7 +46,7 @@
namespace mca {
-/// \brief A view that prints out generic instruction information.
+/// A view that prints out generic instruction information.
class InstructionInfoView : public View {
const llvm::MCSubtargetInfo &STI;
const llvm::MCInstrInfo &MCII;
diff --git a/llvm/tools/llvm-mca/LSUnit.h b/llvm/tools/llvm-mca/LSUnit.h
index 3cfde5a..d291a09 100644
--- a/llvm/tools/llvm-mca/LSUnit.h
+++ b/llvm/tools/llvm-mca/LSUnit.h
@@ -26,7 +26,7 @@
struct InstrDesc;
-/// \brief A Load/Store Unit implementing a load and store queues.
+/// A Load/Store Unit implementing a load and store queues.
///
/// This class implements a load queue and a store queue to emulate the
/// out-of-order execution of memory operations.
diff --git a/llvm/tools/llvm-mca/Scheduler.h b/llvm/tools/llvm-mca/Scheduler.h
index f3b9a36..25bc87e 100644
--- a/llvm/tools/llvm-mca/Scheduler.h
+++ b/llvm/tools/llvm-mca/Scheduler.h
@@ -46,7 +46,7 @@
RS_RESERVED
};
-/// \brief A descriptor for processor resources.
+/// A descriptor for processor resources.
///
/// Each object of class ResourceState is associated to a specific processor
/// resource. There is an instance of this class for every processor resource
@@ -250,7 +250,7 @@
#endif
};
-/// \brief A resource unit identifier.
+/// A resource unit identifier.
///
/// This is used to identify a specific processor resource unit using a pair
/// of indices where the 'first' index is a processor resource mask, and the
diff --git a/llvm/tools/llvm-mca/SummaryView.h b/llvm/tools/llvm-mca/SummaryView.h
index 9c54351..0484057 100644
--- a/llvm/tools/llvm-mca/SummaryView.h
+++ b/llvm/tools/llvm-mca/SummaryView.h
@@ -35,7 +35,7 @@
namespace mca {
-/// \brief A view that collects and prints a few performance numbers.
+/// A view that collects and prints a few performance numbers.
class SummaryView : public View {
const SourceMgr &Source;
const unsigned DispatchWidth;
diff --git a/llvm/tools/llvm-mca/TimelineView.h b/llvm/tools/llvm-mca/TimelineView.h
index 6ec373d..09dc990 100644
--- a/llvm/tools/llvm-mca/TimelineView.h
+++ b/llvm/tools/llvm-mca/TimelineView.h
@@ -109,7 +109,7 @@
namespace mca {
-/// \brief This class listens to instruction state transition events
+/// This class listens to instruction state transition events
/// in order to construct a timeline information.
///
/// For every instruction executed by the Backend, this class constructs