[llvm] cfb5b14 - Fix Wdocumentation warnings by only tagging a param id once per doxygen comment block. NFC.

[Simon Pilgrim via llvm-commits]

Author: Simon Pilgrim
Date: 2020-07-01T12:01:19+01:00
New Revision: cfb5b144cf4686755d9e244bd425221ad88e2a63

URL: https://github.com/llvm/llvm-project/commit/cfb5b144cf4686755d9e244bd425221ad88e2a63
DIFF: https://github.com/llvm/llvm-project/commit/cfb5b144cf4686755d9e244bd425221ad88e2a63.diff

LOG: Fix Wdocumentation warnings by only tagging a param id once per doxygen comment block. NFC.

Added: 
    

Modified: 
    llvm/lib/Transforms/Utils/FlattenCFG.cpp

Removed: 
    


################################################################################
diff  --git a/llvm/lib/Transforms/Utils/FlattenCFG.cpp b/llvm/lib/Transforms/Utils/FlattenCFG.cpp
index 29a4f85e1d7d..0098dcaeb07a 100644
--- a/llvm/lib/Transforms/Utils/FlattenCFG.cpp
+++ b/llvm/lib/Transforms/Utils/FlattenCFG.cpp
@@ -97,7 +97,7 @@ class FlattenCFGOpt {
 ///    br label %if.end;
 ///
 ///  Current implementation handles two cases.
-///  Case 1: \param BB is on the else-path.
+///  Case 1: BB is on the else-path.
 ///
 ///          BB1
 ///        /     |
@@ -105,7 +105,7 @@ class FlattenCFGOpt {
 ///      /   \   |
 ///     BB3   \  |     where, BB1, BB2 contain conditional branches.
 ///      \    |  /     BB3 contains unconditional branch.
-///       \   | /      BB4 corresponds to \param BB which is also the merge.
+///       \   | /      BB4 corresponds to BB which is also the merge.
 ///  BB => BB4
 ///
 ///
@@ -114,14 +114,14 @@ class FlattenCFGOpt {
 ///  if (a == b && c == d)
 ///    statement; // BB3
 ///
-///  Case 2: \param BB BB is on the then-path.
+///  Case 2: BB is on the then-path.
 ///
 ///             BB1
 ///          /      |
 ///         |      BB2
 ///         \    /    |  where BB1, BB2 contain conditional branches.
 ///  BB =>   BB3      |  BB3 contains unconditiona branch and corresponds
-///           \     /    to \param BB.  BB4 is the merge.
+///           \     /    to BB.  BB4 is the merge.
 ///             BB4
 ///
 ///  Corresponding source code:
@@ -129,9 +129,9 @@ class FlattenCFGOpt {
 ///  if (a == b || c == d)
 ///    statement;  // BB3
 ///
-///  In both cases,  \param BB is the common successor of conditional branches.
-///  In Case 1, \param BB (BB4) has an unconditional branch (BB3) as
-///  its predecessor.  In Case 2, \param BB (BB3) only has conditional branches
+///  In both cases, BB is the common successor of conditional branches.
+///  In Case 1, BB (BB4) has an unconditional branch (BB3) as
+///  its predecessor.  In Case 2, BB (BB3) only has conditional branches
 ///  as its predecessors.
 bool FlattenCFGOpt::FlattenParallelAndOr(BasicBlock *BB, IRBuilder<> &Builder) {
   PHINode *PHI = dyn_cast<PHINode>(BB->begin());
@@ -318,8 +318,8 @@ bool FlattenCFGOpt::FlattenParallelAndOr(BasicBlock *BB, IRBuilder<> &Builder) {
 /// Compare blocks from two if-regions, where \param Head2 is the entry of the
 /// 2nd if-region. \param Block1 is a block in the 1st if-region to compare.
 /// \param Block2 is a block in the 2nd if-region to compare.  \returns true if
-/// \param Block1 and \param Block2 have identical instructions and do not have
-/// memory reference alias with \param Head2.
+/// Block1 and Block2 have identical instructions and do not have
+/// memory reference alias with Head2.
 bool FlattenCFGOpt::CompareIfRegionBlock(BasicBlock *Block1, BasicBlock *Block2,
                                          BasicBlock *Head2) {
   Instruction *PTI2 = Head2->getTerminator();