NFC. Add description comments to Function header

[ruiu]

I'm not familiar with this file. Can you re-send it to the person who wrote this code?

[brzycki]

It looks ok to me. I’d prefer the comments reflect the overloaded method parameters but it’s not necessary.

include/llvm/IR/Function.h

267

@Quolyk you might want to mention here this overloaded method uses a string reference to locate the function attribute.

277

Same as line 267.

349

Same as line 267.

[Quolyk]

In D41609#964962, @brzycki wrote:

It looks ok to me. I’d prefer the comments reflect the overloaded method parameters but it’s not necessary.

I've looked through other places with similar semantics, and it's quite common that comments do not reflect parameters type, so I decided to make it that way.

[brzycki]

In D41609#965776, @Quolyk wrote:

In D41609#964962, @brzycki wrote:

It looks ok to me. I’d prefer the comments reflect the overloaded method parameters but it’s not necessary.

I've looked through other places with similar semantics, and it's quite common that comments do not reflect parameters type, so I decided to make it that way.

Sounds good to me. Adding documentation is always appreciated.

include/llvm/IR/Function.h

public:
   }
 
   /// @brief Add function attributes to this function.
   void addFnAttr(StringRef Kind, StringRef Val = StringRef()) {
     addAttribute(AttributeList::FunctionIndex,
                  Attribute::get(getContext(), Kind, Val));
   }
 
+  /// @brief Add function attributes to this function.
   void addFnAttr(Attribute Attr) {
     addAttribute(AttributeList::FunctionIndex, Attr);
   }
 
   /// @brief Remove function attributes from this function.
   void removeFnAttr(Attribute::AttrKind Kind) {
     removeAttribute(AttributeList::FunctionIndex, Kind);
   }
public:
 
   /// Get the section prefix for this function.
   Optional<StringRef> getSectionPrefix() const;
 
   /// @brief Return true if the function has the attribute.
   bool hasFnAttribute(Attribute::AttrKind Kind) const {
     return AttributeSets.hasFnAttribute(Kind);
   }
+
+  /// @brief Return true if the function has the attribute.
   bool hasFnAttribute(StringRef Kind) const {
     return AttributeSets.hasFnAttribute(Kind);
   }
 
   /// @brief Return the attribute for the given attribute kind.
   Attribute getFnAttribute(Attribute::AttrKind Kind) const {
     return getAttribute(AttributeList::FunctionIndex, Kind);
   }
+
+  /// @brief Return the attribute for the given attribute kind.
   Attribute getFnAttribute(StringRef Kind) const {
     return getAttribute(AttributeList::FunctionIndex, Kind);
   }
 
   /// \brief Return the stack alignment for the function.
   unsigned getFnStackAlignment() const {
     if (!hasFnAttribute(Attribute::StackAlignment))
       return 0;
bool hasAttribute(unsigned i, Attribute::AttrKind Kind) const {
     return getAttributes().hasAttribute(i, Kind);
   }
 
   /// @brief check if an attributes is in the list of attributes.
   bool hasParamAttribute(unsigned ArgNo, Attribute::AttrKind Kind) const {
     return getAttributes().hasParamAttribute(ArgNo, Kind);
   }
 
+  /// @brief gets the attribute from the list of attributes.
   Attribute getAttribute(unsigned i, Attribute::AttrKind Kind) const {
     return AttributeSets.getAttribute(i, Kind);
   }
 
+  /// @brief gets the attribute from the list of attributes.
   Attribute getAttribute(unsigned i, StringRef Kind) const {
     return AttributeSets.getAttribute(i, Kind);
   }
 
   /// @brief adds the dereferenceable attribute to the list of attributes.
   void addDereferenceableAttr(unsigned i, uint64_t Bytes);
 
   /// @brief adds the dereferenceable attribute to the list of attributes for