[llvm] 77f6c0b - Fix Wdocumentation warnings. NFCI.

[Simon Pilgrim via llvm-commits]

Author: Simon Pilgrim
Date: 2021-09-17T12:45:56+01:00
New Revision: 77f6c0bcaa267541886b5e025cde16ff5bf8dec4

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

LOG: Fix Wdocumentation warnings. NFCI.

Fix parameter name typos and drop returns statements from void functions

Added: 
    

Modified: 
    llvm/include/llvm/Analysis/IRSimilarityIdentifier.h
    llvm/lib/Transforms/IPO/IROutliner.cpp

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/Analysis/IRSimilarityIdentifier.h b/llvm/include/llvm/Analysis/IRSimilarityIdentifier.h
index c01540bae41e..51c5c620230b 100644
--- a/llvm/include/llvm/Analysis/IRSimilarityIdentifier.h
+++ b/llvm/include/llvm/Analysis/IRSimilarityIdentifier.h
@@ -729,7 +729,6 @@ class IRSimilarityCandidate {
       DenseMap<unsigned, DenseSet<unsigned>> &FromSourceMapping);
 
   /// \param [in,out] BBSet - The set to track the basic blocks.
-  /// \returns The BasicBlock the IRSimilarityCandidate ends in.
   void getBasicBlocks(DenseSet<BasicBlock *> &BBSet) const {
     for (IRInstructionData &ID : *this) {
       BasicBlock *BB = ID.Inst->getParent();
@@ -741,7 +740,6 @@ class IRSimilarityCandidate {
 
   /// \param [in,out] BBSet - The set to track the basic blocks.
   /// \param [in,out] BBList - A list in order of use to track the basic blocks.
-  /// \returns The BasicBlock the IRSimilarityCandidate ends in.
   void getBasicBlocks(DenseSet<BasicBlock *> &BBSet,
                       SmallVector<BasicBlock *> &BBList) const {
     for (IRInstructionData &ID : *this) {

diff  --git a/llvm/lib/Transforms/IPO/IROutliner.cpp b/llvm/lib/Transforms/IPO/IROutliner.cpp
index 3cfd49b0f82b..e079bc1db11f 100644
--- a/llvm/lib/Transforms/IPO/IROutliner.cpp
+++ b/llvm/lib/Transforms/IPO/IROutliner.cpp
@@ -525,7 +525,6 @@ Function *IROutliner::createFunction(Module &M, OutlinableGroup &Group,
 /// \param [in] Old - The function to move the basic blocks from.
 /// \param [in] New - The function to move the basic blocks to.
 /// \param [out] NewEnds - The return blocks of the new overall function.
-/// \returns the first return block for the function in New.
 static void moveFunctionData(Function &Old, Function &New,
                              DenseMap<Value *, BasicBlock *> &NewEnds) {
   Function::iterator CurrBB, NextBB, FinalBB;
@@ -1075,7 +1074,7 @@ CallInst *replaceCalledFunction(Module &M, OutlinableRegion &Region) {
 // region with the arguments of the function for an OutlinableGroup.
 //
 /// \param [in] Region - The region of extracted code to be changed.
-/// \param [in,out] OutputBB - The BasicBlock for the output stores for this
+/// \param [in,out] OutputBBs - The BasicBlock for the output stores for this
 /// region.
 /// \param [in] FirstFunction - A flag to indicate whether we are using this
 /// function to define the overall outlined function for all the regions, or
@@ -1207,7 +1206,7 @@ void replaceConstants(OutlinableRegion &Region) {
 /// It is possible that there is a basic block that already performs the same
 /// stores. This returns a duplicate block, if it exists
 ///
-/// \param OutputBB [in] the block we are looking for a duplicate of.
+/// \param OutputBBs [in] the blocks we are looking for a duplicate of.
 /// \param OutputStoreBBs [in] The existing output blocks.
 /// \returns an optional value with the number output block if there is a match.
 Optional<unsigned> findDuplicateOutputBlock(
@@ -1306,9 +1305,9 @@ analyzeAndPruneOutputBlocks(DenseMap<Value *, BasicBlock *> &BlocksToPrune,
 ///
 /// \param [in] OG - The OutlinableGroup of regions to be outlined.
 /// \param [in] Region - The OutlinableRegion that is being analyzed.
-/// \param [in,out] OutputBB - the block that stores for this region will be
+/// \param [in,out] OutputBBs - the blocks that stores for this region will be
 /// placed in.
-/// \param [in] EndBB - the final block of the extracted function.
+/// \param [in] EndBBs - the final blocks of the extracted function.
 /// \param [in] OutputMappings - OutputMappings the mapping of values that have
 /// been replaced by a new output value.
 /// \param [in,out] OutputStoreBBs - The existing output blocks.
@@ -1392,7 +1391,7 @@ static void createAndInsertBasicBlocks(DenseMap<Value *, BasicBlock *> &OldMap,
 /// matches the needed stores for the extracted section.
 /// \param [in] M - The module we are outlining from.
 /// \param [in] OG - The group of regions to be outlined.
-/// \param [in] EndBB - The final block of the extracted function.
+/// \param [in] EndBBs - The final blocks of the extracted function.
 /// \param [in,out] OutputStoreBBs - The existing output blocks.
 void createSwitchStatement(
     Module &M, OutlinableGroup &OG, DenseMap<Value *, BasicBlock *> &EndBBs,