Remove @brief commands from doxygen comments, too.
This is a follow-up to r331272.
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
https://reviews.llvm.org/D46290
llvm-svn: 331275
diff --git a/llvm/lib/Support/APInt.cpp b/llvm/lib/Support/APInt.cpp
index a09ace5..98e44d2 100644
--- a/llvm/lib/Support/APInt.cpp
+++ b/llvm/lib/Support/APInt.cpp
@@ -168,7 +168,7 @@
ID.AddInteger(U.pVal[i]);
}
-/// @brief Prefix increment operator. Increments the APInt by one.
+/// Prefix increment operator. Increments the APInt by one.
APInt& APInt::operator++() {
if (isSingleWord())
++U.VAL;
@@ -177,7 +177,7 @@
return clearUnusedBits();
}
-/// @brief Prefix decrement operator. Decrements the APInt by one.
+/// Prefix decrement operator. Decrements the APInt by one.
APInt& APInt::operator--() {
if (isSingleWord())
--U.VAL;
@@ -188,7 +188,7 @@
/// Adds the RHS APint to this APInt.
/// @returns this, after addition of RHS.
-/// @brief Addition assignment operator.
+/// Addition assignment operator.
APInt& APInt::operator+=(const APInt& RHS) {
assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
if (isSingleWord())
@@ -208,7 +208,7 @@
/// Subtracts the RHS APInt from this APInt
/// @returns this, after subtraction
-/// @brief Subtraction assignment operator.
+/// Subtraction assignment operator.
APInt& APInt::operator-=(const APInt& RHS) {
assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
if (isSingleWord())
@@ -326,7 +326,7 @@
U.pVal[word] = WORD_MAX;
}
-/// @brief Toggle every bit to its opposite value.
+/// Toggle every bit to its opposite value.
void APInt::flipAllBitsSlowCase() {
tcComplement(U.pVal, getNumWords());
clearUnusedBits();
@@ -334,7 +334,7 @@
/// Toggle a given bit to its opposite value whose position is given
/// as "bitPosition".
-/// @brief Toggles a given bit to its opposite value.
+/// Toggles a given bit to its opposite value.
void APInt::flipBit(unsigned bitPosition) {
assert(bitPosition < BitWidth && "Out of the bit-width range!");
if ((*this)[bitPosition]) clearBit(bitPosition);
@@ -908,13 +908,13 @@
}
/// Arithmetic right-shift this APInt by shiftAmt.
-/// @brief Arithmetic right-shift function.
+/// Arithmetic right-shift function.
void APInt::ashrInPlace(const APInt &shiftAmt) {
ashrInPlace((unsigned)shiftAmt.getLimitedValue(BitWidth));
}
/// Arithmetic right-shift this APInt by shiftAmt.
-/// @brief Arithmetic right-shift function.
+/// Arithmetic right-shift function.
void APInt::ashrSlowCase(unsigned ShiftAmt) {
// Don't bother performing a no-op shift.
if (!ShiftAmt)
@@ -957,19 +957,19 @@
}
/// Logical right-shift this APInt by shiftAmt.
-/// @brief Logical right-shift function.
+/// Logical right-shift function.
void APInt::lshrInPlace(const APInt &shiftAmt) {
lshrInPlace((unsigned)shiftAmt.getLimitedValue(BitWidth));
}
/// Logical right-shift this APInt by shiftAmt.
-/// @brief Logical right-shift function.
+/// Logical right-shift function.
void APInt::lshrSlowCase(unsigned ShiftAmt) {
tcShiftRight(U.pVal, getNumWords(), ShiftAmt);
}
/// Left-shift this APInt by shiftAmt.
-/// @brief Left-shift function.
+/// Left-shift function.
APInt &APInt::operator<<=(const APInt &shiftAmt) {
// It's undefined behavior in C to shift by BitWidth or greater.
*this <<= (unsigned)shiftAmt.getLimitedValue(BitWidth);
diff --git a/llvm/lib/Support/Unix/Unix.h b/llvm/lib/Support/Unix/Unix.h
index 239a6d6..0c5d4de 100644
--- a/llvm/lib/Support/Unix/Unix.h
+++ b/llvm/lib/Support/Unix/Unix.h
@@ -56,7 +56,7 @@
/// This function builds an error message into \p ErrMsg using the \p prefix
/// string and the Unix error number given by \p errnum. If errnum is -1, the
/// default then the value of errno is used.
-/// @brief Make an error message
+/// Make an error message
///
/// If the error number can be converted to a string, it will be
/// separated from prefix by ": ".
diff --git a/llvm/lib/Support/YAMLParser.cpp b/llvm/lib/Support/YAMLParser.cpp
index 3f71ab8..354b7d0 100644
--- a/llvm/lib/Support/YAMLParser.cpp
+++ b/llvm/lib/Support/YAMLParser.cpp
@@ -168,7 +168,7 @@
namespace {
-/// @brief This struct is used to track simple keys.
+/// This struct is used to track simple keys.
///
/// Simple keys are handled by creating an entry in SimpleKeys for each Token
/// which could legally be the start of a simple key. When peekNext is called,
@@ -191,7 +191,7 @@
} // end anonymous namespace
-/// @brief The Unicode scalar value of a UTF-8 minimal well-formed code unit
+/// The Unicode scalar value of a UTF-8 minimal well-formed code unit
/// subsequence and the subsequence's length in code units (uint8_t).
/// A length of 0 represents an error.
using UTF8Decoded = std::pair<uint32_t, unsigned>;
@@ -249,7 +249,7 @@
namespace llvm {
namespace yaml {
-/// @brief Scans YAML tokens from a MemoryBuffer.
+/// Scans YAML tokens from a MemoryBuffer.
class Scanner {
public:
Scanner(StringRef Input, SourceMgr &SM, bool ShowColors = true,
@@ -257,10 +257,10 @@
Scanner(MemoryBufferRef Buffer, SourceMgr &SM_, bool ShowColors = true,
std::error_code *EC = nullptr);
- /// @brief Parse the next token and return it without popping it.
+ /// Parse the next token and return it without popping it.
Token &peekNext();
- /// @brief Parse the next token and pop it from the queue.
+ /// Parse the next token and pop it from the queue.
Token getNext();
void printError(SMLoc Loc, SourceMgr::DiagKind Kind, const Twine &Message,
@@ -287,7 +287,7 @@
setError(Message, Current);
}
- /// @brief Returns true if an error occurred while parsing.
+ /// Returns true if an error occurred while parsing.
bool failed() {
return Failed;
}
@@ -299,7 +299,7 @@
return StringRef(Current, End - Current);
}
- /// @brief Decode a UTF-8 minimal well-formed code unit subsequence starting
+ /// Decode a UTF-8 minimal well-formed code unit subsequence starting
/// at \a Position.
///
/// If the UTF-8 code units starting at Position do not form a well-formed
@@ -329,7 +329,7 @@
// l-
// A production matching complete line(s).
- /// @brief Skip a single nb-char[27] starting at Position.
+ /// Skip a single nb-char[27] starting at Position.
///
/// A nb-char is 0x9 | [0x20-0x7E] | 0x85 | [0xA0-0xD7FF] | [0xE000-0xFEFE]
/// | [0xFF00-0xFFFD] | [0x10000-0x10FFFF]
@@ -338,7 +338,7 @@
/// nb-char.
StringRef::iterator skip_nb_char(StringRef::iterator Position);
- /// @brief Skip a single b-break[28] starting at Position.
+ /// Skip a single b-break[28] starting at Position.
///
/// A b-break is 0xD 0xA | 0xD | 0xA
///
@@ -354,7 +354,7 @@
/// s-space.
StringRef::iterator skip_s_space(StringRef::iterator Position);
- /// @brief Skip a single s-white[33] starting at Position.
+ /// Skip a single s-white[33] starting at Position.
///
/// A s-white is 0x20 | 0x9
///
@@ -362,7 +362,7 @@
/// s-white.
StringRef::iterator skip_s_white(StringRef::iterator Position);
- /// @brief Skip a single ns-char[34] starting at Position.
+ /// Skip a single ns-char[34] starting at Position.
///
/// A ns-char is nb-char - s-white
///
@@ -372,7 +372,7 @@
using SkipWhileFunc = StringRef::iterator (Scanner::*)(StringRef::iterator);
- /// @brief Skip minimal well-formed code unit subsequences until Func
+ /// Skip minimal well-formed code unit subsequences until Func
/// returns its input.
///
/// @returns The code unit after the last minimal well-formed code unit
@@ -384,20 +384,20 @@
/// input.
void advanceWhile(SkipWhileFunc Func);
- /// @brief Scan ns-uri-char[39]s starting at Cur.
+ /// Scan ns-uri-char[39]s starting at Cur.
///
/// This updates Cur and Column while scanning.
void scan_ns_uri_char();
- /// @brief Consume a minimal well-formed code unit subsequence starting at
+ /// Consume a minimal well-formed code unit subsequence starting at
/// \a Cur. Return false if it is not the same Unicode scalar value as
/// \a Expected. This updates \a Column.
bool consume(uint32_t Expected);
- /// @brief Skip \a Distance UTF-8 code units. Updates \a Cur and \a Column.
+ /// Skip \a Distance UTF-8 code units. Updates \a Cur and \a Column.
void skip(uint32_t Distance);
- /// @brief Return true if the minimal well-formed code unit subsequence at
+ /// Return true if the minimal well-formed code unit subsequence at
/// Pos is whitespace or a new line
bool isBlankOrBreak(StringRef::iterator Position);
@@ -406,77 +406,77 @@
/// Return false if the code unit at the current position isn't a line break.
bool consumeLineBreakIfPresent();
- /// @brief If IsSimpleKeyAllowed, create and push_back a new SimpleKey.
+ /// If IsSimpleKeyAllowed, create and push_back a new SimpleKey.
void saveSimpleKeyCandidate( TokenQueueT::iterator Tok
, unsigned AtColumn
, bool IsRequired);
- /// @brief Remove simple keys that can no longer be valid simple keys.
+ /// Remove simple keys that can no longer be valid simple keys.
///
/// Invalid simple keys are not on the current line or are further than 1024
/// columns back.
void removeStaleSimpleKeyCandidates();
- /// @brief Remove all simple keys on FlowLevel \a Level.
+ /// Remove all simple keys on FlowLevel \a Level.
void removeSimpleKeyCandidatesOnFlowLevel(unsigned Level);
- /// @brief Unroll indentation in \a Indents back to \a Col. Creates BlockEnd
+ /// Unroll indentation in \a Indents back to \a Col. Creates BlockEnd
/// tokens if needed.
bool unrollIndent(int ToColumn);
- /// @brief Increase indent to \a Col. Creates \a Kind token at \a InsertPoint
+ /// Increase indent to \a Col. Creates \a Kind token at \a InsertPoint
/// if needed.
bool rollIndent( int ToColumn
, Token::TokenKind Kind
, TokenQueueT::iterator InsertPoint);
- /// @brief Skip a single-line comment when the comment starts at the current
+ /// Skip a single-line comment when the comment starts at the current
/// position of the scanner.
void skipComment();
- /// @brief Skip whitespace and comments until the start of the next token.
+ /// Skip whitespace and comments until the start of the next token.
void scanToNextToken();
- /// @brief Must be the first token generated.
+ /// Must be the first token generated.
bool scanStreamStart();
- /// @brief Generate tokens needed to close out the stream.
+ /// Generate tokens needed to close out the stream.
bool scanStreamEnd();
- /// @brief Scan a %BLAH directive.
+ /// Scan a %BLAH directive.
bool scanDirective();
- /// @brief Scan a ... or ---.
+ /// Scan a ... or ---.
bool scanDocumentIndicator(bool IsStart);
- /// @brief Scan a [ or { and generate the proper flow collection start token.
+ /// Scan a [ or { and generate the proper flow collection start token.
bool scanFlowCollectionStart(bool IsSequence);
- /// @brief Scan a ] or } and generate the proper flow collection end token.
+ /// Scan a ] or } and generate the proper flow collection end token.
bool scanFlowCollectionEnd(bool IsSequence);
- /// @brief Scan the , that separates entries in a flow collection.
+ /// Scan the , that separates entries in a flow collection.
bool scanFlowEntry();
- /// @brief Scan the - that starts block sequence entries.
+ /// Scan the - that starts block sequence entries.
bool scanBlockEntry();
- /// @brief Scan an explicit ? indicating a key.
+ /// Scan an explicit ? indicating a key.
bool scanKey();
- /// @brief Scan an explicit : indicating a value.
+ /// Scan an explicit : indicating a value.
bool scanValue();
- /// @brief Scan a quoted scalar.
+ /// Scan a quoted scalar.
bool scanFlowScalar(bool IsDoubleQuoted);
- /// @brief Scan an unquoted scalar.
+ /// Scan an unquoted scalar.
bool scanPlainScalar();
- /// @brief Scan an Alias or Anchor starting with * or &.
+ /// Scan an Alias or Anchor starting with * or &.
bool scanAliasOrAnchor(bool IsAlias);
- /// @brief Scan a block scalar starting with | or >.
+ /// Scan a block scalar starting with | or >.
bool scanBlockScalar(bool IsLiteral);
/// Scan a chomping indicator in a block scalar header.
@@ -503,57 +503,57 @@
bool scanBlockScalarIndent(unsigned BlockIndent, unsigned BlockExitIndent,
bool &IsDone);
- /// @brief Scan a tag of the form !stuff.
+ /// Scan a tag of the form !stuff.
bool scanTag();
- /// @brief Dispatch to the next scanning function based on \a *Cur.
+ /// Dispatch to the next scanning function based on \a *Cur.
bool fetchMoreTokens();
- /// @brief The SourceMgr used for diagnostics and buffer management.
+ /// The SourceMgr used for diagnostics and buffer management.
SourceMgr &SM;
- /// @brief The original input.
+ /// The original input.
MemoryBufferRef InputBuffer;
- /// @brief The current position of the scanner.
+ /// The current position of the scanner.
StringRef::iterator Current;
- /// @brief The end of the input (one past the last character).
+ /// The end of the input (one past the last character).
StringRef::iterator End;
- /// @brief Current YAML indentation level in spaces.
+ /// Current YAML indentation level in spaces.
int Indent;
- /// @brief Current column number in Unicode code points.
+ /// Current column number in Unicode code points.
unsigned Column;
- /// @brief Current line number.
+ /// Current line number.
unsigned Line;
- /// @brief How deep we are in flow style containers. 0 Means at block level.
+ /// How deep we are in flow style containers. 0 Means at block level.
unsigned FlowLevel;
- /// @brief Are we at the start of the stream?
+ /// Are we at the start of the stream?
bool IsStartOfStream;
- /// @brief Can the next token be the start of a simple key?
+ /// Can the next token be the start of a simple key?
bool IsSimpleKeyAllowed;
- /// @brief True if an error has occurred.
+ /// True if an error has occurred.
bool Failed;
- /// @brief Should colors be used when printing out the diagnostic messages?
+ /// Should colors be used when printing out the diagnostic messages?
bool ShowColors;
- /// @brief Queue of tokens. This is required to queue up tokens while looking
+ /// Queue of tokens. This is required to queue up tokens while looking
/// for the end of a simple key. And for cases where a single character
/// can produce multiple tokens (e.g. BlockEnd).
TokenQueueT TokenQueue;
- /// @brief Indentation levels.
+ /// Indentation levels.
SmallVector<int, 4> Indents;
- /// @brief Potential simple keys.
+ /// Potential simple keys.
SmallVector<SimpleKey, 4> SimpleKeys;
std::error_code *EC;