[llvm] r205116 - Fix a few -Wdocumentation warnings

[Dmitri Gribenko]

Author: gribozavr
Date: Sat Mar 29 14:40:32 2014
New Revision: 205116

URL: http://llvm.org/viewvc/llvm-project?rev=205116&view=rev
Log:
Fix a few -Wdocumentation warnings

Modified:
    llvm/trunk/lib/Target/ARM64/ARM64CollectLOH.cpp
    llvm/trunk/lib/Target/ARM64/ARM64ISelLowering.cpp
    llvm/trunk/lib/Target/ARM64/ARM64PromoteConstant.cpp
    llvm/trunk/lib/Target/ARM64/AsmParser/ARM64AsmParser.cpp

Modified: llvm/trunk/lib/Target/ARM64/ARM64CollectLOH.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Target/ARM64/ARM64CollectLOH.cpp?rev=205116&r1=205115&r2=205116&view=diff
==============================================================================
--- llvm/trunk/lib/Target/ARM64/ARM64CollectLOH.cpp (original)
+++ llvm/trunk/lib/Target/ARM64/ARM64CollectLOH.cpp Sat Mar 29 14:40:32 2014
@@ -222,7 +222,7 @@ static const SetOfMachineInstr *getUses(
 /// - its kill set.
 /// - its reachable uses (uses that are exposed to BB's predecessors).
 /// - its the generated definitions.
-/// \param DummyOp, if not NULL, specifies a Dummy Operation to be added to
+/// \param DummyOp if not NULL, specifies a Dummy Operation to be added to
 /// the list of uses of exposed defintions.
 /// \param ADRPMode specifies to only consider ADRP instructions for generated
 /// definition. It also consider definitions of ADRP instructions as uses and
@@ -417,11 +417,11 @@ static void finitReachingDef(BlockToSetO
 
 /// Reaching definiton algorithm.
 /// \param MF function on which the algorithm will operate.
-/// \param ColorOpToReachedUses[out] will contain the result of the reaching
+/// \param[out] ColorOpToReachedUses will contain the result of the reaching
 /// def algorithm.
 /// \param ADRPMode specify whether the reaching def algorithm should be tuned
 /// for ADRP optimization. \see initReachingDef for more details.
-/// \param DummyOp, if not NULL, the algorithm will work at
+/// \param DummyOp if not NULL, the algorithm will work at
 /// basic block scope and will set for every exposed defintion a use to
 /// @p DummyOp.
 /// \pre ColorOpToReachedUses is an array of at least number of registers of

Modified: llvm/trunk/lib/Target/ARM64/ARM64ISelLowering.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Target/ARM64/ARM64ISelLowering.cpp?rev=205116&r1=205115&r2=205116&view=diff
==============================================================================
--- llvm/trunk/lib/Target/ARM64/ARM64ISelLowering.cpp (original)
+++ llvm/trunk/lib/Target/ARM64/ARM64ISelLowering.cpp Sat Mar 29 14:40:32 2014
@@ -1740,9 +1740,9 @@ static SDValue LowerPREFETCH(SDValue Op,
   }
 
   // built the mask value encoding the expected behavior.
-  unsigned PrfOp = (IsWrite << 4) |  //< Load/Store bit
-                   (Locality << 1) | //< Cache level bits
-                   IsStream;         //< Stream bit
+  unsigned PrfOp = (IsWrite << 4) |  // Load/Store bit
+                   (Locality << 1) | // Cache level bits
+                   IsStream;         // Stream bit
   return DAG.getNode(ARM64ISD::PREFETCH, DL, MVT::Other, Op.getOperand(0),
                      DAG.getConstant(PrfOp, MVT::i32), Op.getOperand(1));
 }

Modified: llvm/trunk/lib/Target/ARM64/ARM64PromoteConstant.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Target/ARM64/ARM64PromoteConstant.cpp?rev=205116&r1=205115&r2=205116&view=diff
==============================================================================
--- llvm/trunk/lib/Target/ARM64/ARM64PromoteConstant.cpp (original)
+++ llvm/trunk/lib/Target/ARM64/ARM64PromoteConstant.cpp Sat Mar 29 14:40:32 2014
@@ -132,8 +132,8 @@ private:
   /// \param UseIt the use to be added into the list of dominated uses
   /// \param InsertPts existing insertion points
   /// \pre NewPt and all instruction in InsertPts belong to the same function
-  /// \retun true if one of the insertion point in InsertPts dominates NewPt,
-  ///        false otherwise
+  /// \return true if one of the insertion point in InsertPts dominates NewPt,
+  ///         false otherwise
   bool isDominated(Instruction *NewPt, Value::user_iterator &UseIt,
                    InsertionPoints &InsertPts);
 
@@ -146,9 +146,9 @@ private:
   /// \param InsertPts existing insertion points
   /// \pre NewPt and all instruction in InsertPts belong to the same function
   /// \pre isDominated returns false for the exact same parameters.
-  /// \retun true if it exists an insertion point in InsertPts that could
-  ///        have been merged with NewPt in a common dominator,
-  ///        false otherwise
+  /// \return true if it exists an insertion point in InsertPts that could
+  ///         have been merged with NewPt in a common dominator,
+  ///         false otherwise
   bool tryAndMerge(Instruction *NewPt, Value::user_iterator &UseIt,
                    InsertionPoints &InsertPts);
 
@@ -157,7 +157,7 @@ private:
   /// Insertion points are group per function and each insertion point
   /// contains a list of all the uses it dominates within the related function
   /// \param Val constant to be examined
-  /// \param InsPtsPerFunc[out] output storage of the analysis
+  /// \param[out] InsPtsPerFunc output storage of the analysis
   void computeInsertionPoints(Constant *Val,
                               InsertionPointsPerFunc &InsPtsPerFunc);
 

Modified: llvm/trunk/lib/Target/ARM64/AsmParser/ARM64AsmParser.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Target/ARM64/AsmParser/ARM64AsmParser.cpp?rev=205116&r1=205115&r2=205116&view=diff
==============================================================================
--- llvm/trunk/lib/Target/ARM64/AsmParser/ARM64AsmParser.cpp (original)
+++ llvm/trunk/lib/Target/ARM64/AsmParser/ARM64AsmParser.cpp Sat Mar 29 14:40:32 2014
@@ -42,7 +42,7 @@ public:
   typedef SmallVectorImpl<MCParsedAsmOperand *> OperandVector;
 
 private:
-  StringRef Mnemonic; //< Instruction mnemonic.
+  StringRef Mnemonic; ///< Instruction mnemonic.
   MCSubtargetInfo &STI;
   MCAsmParser &Parser;