Various improvements suggested by Duncan

llvm-svn: 48325

llvm/include/llvm/Function.h

@@ -144,10 +144,12 @@ public:
     SubclassData = (SubclassData & 1) | (CC << 1);
   }
   
-  /// getParamAttrs - Return the parameter attributes for this function.
+  /// getParamAttrs - Return the parameter attributes for this Function.
+  ///
   const PAListPtr &getParamAttrs() const { return ParamAttrs; }
 
   /// setParamAttrs - Set the parameter attributes for this Function.
+  ///
   void setParamAttrs(const PAListPtr &attrs) { ParamAttrs = attrs; }
 
   /// hasCollector/getCollector/setCollector/clearCollector - The name of the

llvm/include/llvm/Instructions.h

@@ -926,11 +926,11 @@ public:
     SubclassData = (SubclassData & 1) | (CC << 1);
   }
 
-  /// getParamAttrs - Return the PAListPtr for the parameter attributes of this
-  /// call.
+  /// getParamAttrs - Return the parameter attributes for this call.
+  ///
   const PAListPtr &getParamAttrs() const { return ParamAttrs; }
 
-  /// setParamAttrs - Sets the parameter attributes for this CallInst.
+  /// setParamAttrs - Sets the parameter attributes for this call.
   void setParamAttrs(const PAListPtr &Attrs) { ParamAttrs = Attrs; }
 
   /// @brief Determine whether the call or the callee has the given attribute.
@@ -1740,11 +1740,11 @@ public:
     SubclassData = CC;
   }
 
-  /// getParamAttrs - Return the parameter attribute list for this invoke.
+  /// getParamAttrs - Return the parameter attributes for this invoke.
   ///
   const PAListPtr &getParamAttrs() const { return ParamAttrs; }
 
-  /// setParamAttrs - Set the parameter attribute list for this invoke.
+  /// setParamAttrs - Set the parameter attributes for this invoke.
   ///
   void setParamAttrs(const PAListPtr &Attrs) { ParamAttrs = Attrs; }
 

llvm/include/llvm/ParameterAttributes.h

@@ -120,7 +120,7 @@ public:
   static PAListPtr get(const ParamAttrsWithIndex *Attr, unsigned NumAttrs);
   
   /// get - Return a ParamAttr list with the parameters specified by the
-  /// consequtive random access iterator range.
+  /// consecutive random access iterator range.
   template <typename Iter>
   static PAListPtr get(const Iter &I, const Iter &E) {
     if (I == E) return PAListPtr();  // Empty list.
@@ -161,7 +161,7 @@ public:
   /// least one parameter or for the return value.
   bool hasAttrSomewhere(ParameterAttributes Attr) const;
 
-  /// operator< - Provide an ordering for parameter attribute lists.
+  /// operator==/!= - Provide equality predicates.
   bool operator==(const PAListPtr &RHS) const { return PAList == RHS.PAList; }
   bool operator!=(const PAListPtr &RHS) const { return PAList != RHS.PAList; }
   

llvm/lib/VMCore/ParameterAttributes.cpp

@@ -77,7 +77,7 @@ namespace llvm {
 class ParamAttributeListImpl : public FoldingSetNode {
   unsigned RefCount;
   
-  // ParamAttrsList is uniqued, these should not be publicly available
+  // ParamAttrsList is uniqued, these should not be publicly available.
   void operator=(const ParamAttributeListImpl &); // Do not implement
   ParamAttributeListImpl(const ParamAttributeListImpl &); // Do not implement
   ~ParamAttributeListImpl();                        // Private implementation