From dd591da2f0f6926a606371437f88ffaa8fb7de3d Mon Sep 17 00:00:00 2001 From: Sanjay Patel Date: Tue, 14 Feb 2017 16:43:49 +0000 Subject: [PATCH] fix documentation comments for Argument; NFC git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@295068 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/llvm/IR/Argument.h | 73 ++++++++++++++------------------------ lib/IR/Function.cpp | 28 --------------- 2 files changed, 27 insertions(+), 74 deletions(-) diff --git a/include/llvm/IR/Argument.h b/include/llvm/IR/Argument.h index d8b280a66f1..f64d9c33baf 100644 --- a/include/llvm/IR/Argument.h +++ b/include/llvm/IR/Argument.h @@ -23,8 +23,6 @@ namespace llvm { template class SymbolTableListTraits; -/// \brief LLVM Argument representation -/// /// This class represents an incoming formal argument to a Function. A formal /// argument, since it is ``formal'', does not contain an actual value but /// instead represents the type, argument number, and attributes of an argument @@ -39,8 +37,6 @@ class Argument : public Value, public ilist_node { void setParent(Function *parent); public: - /// \brief Constructor. - /// /// If \p F is specified, the argument is inserted at the end of the argument /// list for \p F. explicit Argument(Type *Ty, const Twine &Name = "", Function *F = nullptr); @@ -48,100 +44,85 @@ public: inline const Function *getParent() const { return Parent; } inline Function *getParent() { return Parent; } - /// \brief Return the index of this formal argument in its containing - /// function. + /// Return the index of this formal argument in its containing function. /// /// For example in "void foo(int a, float b)" a is 0 and b is 1. unsigned getArgNo() const; - /// \brief Return true if this argument has the nonnull attribute on it in - /// its containing function. Also returns true if at least one byte is known - /// to be dereferenceable and the pointer is in addrspace(0). + /// Return true if this argument has the nonnull attribute. Also returns true + /// if at least one byte is known to be dereferenceable and the pointer is in + /// addrspace(0). bool hasNonNullAttr() const; - /// \brief If this argument has the dereferenceable attribute on it in its - /// containing function, return the number of bytes known to be - /// dereferenceable. Otherwise, zero is returned. + /// If this argument has the dereferenceable attribute, return the number of + /// bytes known to be dereferenceable. Otherwise, zero is returned. uint64_t getDereferenceableBytes() const; - /// \brief If this argument has the dereferenceable_or_null attribute on - /// it in its containing function, return the number of bytes known to be - /// dereferenceable. Otherwise, zero is returned. + /// If this argument has the dereferenceable_or_null attribute, return the + /// number of bytes known to be dereferenceable. Otherwise, zero is returned. uint64_t getDereferenceableOrNullBytes() const; - /// \brief Return true if this argument has the byval attribute on it in its - /// containing function. + /// Return true if this argument has the byval attribute. bool hasByValAttr() const; - /// \brief Return true if this argument has the swiftself attribute. + /// Return true if this argument has the swiftself attribute. bool hasSwiftSelfAttr() const; - /// \brief Return true if this argument has the swifterror attribute. + /// Return true if this argument has the swifterror attribute. bool hasSwiftErrorAttr() const; - /// \brief Return true if this argument has the byval attribute or inalloca - /// attribute on it in its containing function. These attributes both - /// represent arguments being passed by value. + /// Return true if this argument has the byval attribute or inalloca + /// attribute. These attributes represent arguments being passed by value. bool hasByValOrInAllocaAttr() const; - /// \brief If this is a byval or inalloca argument, return its alignment. + /// If this is a byval or inalloca argument, return its alignment. unsigned getParamAlignment() const; - /// \brief Return true if this argument has the nest attribute on it in its - /// containing function. + /// Return true if this argument has the nest attribute. bool hasNestAttr() const; - /// \brief Return true if this argument has the noalias attribute on it in its - /// containing function. + /// Return true if this argument has the noalias attribute. bool hasNoAliasAttr() const; - /// \brief Return true if this argument has the nocapture attribute on it in - /// its containing function. + /// Return true if this argument has the nocapture attribute. bool hasNoCaptureAttr() const; - /// \brief Return true if this argument has the sret attribute on it in its - /// containing function. + /// Return true if this argument has the sret attribute. bool hasStructRetAttr() const; - /// \brief Return true if this argument has the returned attribute on it in - /// its containing function. + /// Return true if this argument has the returned attribute. bool hasReturnedAttr() const; - /// \brief Return true if this argument has the readonly or readnone attribute - /// on it in its containing function. + /// Return true if this argument has the readonly or readnone attribute. bool onlyReadsMemory() const; - /// \brief Return true if this argument has the inalloca attribute on it in - /// its containing function. + /// Return true if this argument has the inalloca attribute. bool hasInAllocaAttr() const; - /// \brief Return true if this argument has the zext attribute on it in its - /// containing function. + /// Return true if this argument has the zext attribute. bool hasZExtAttr() const; - /// \brief Return true if this argument has the sext attribute on it in its - /// containing function. + /// Return true if this argument has the sext attribute. bool hasSExtAttr() const; - /// \brief Add a Attribute to an argument. + /// Add attributes to an argument. void addAttr(AttributeSet AS); void addAttr(Attribute::AttrKind Kind) { addAttr(AttributeSet::get(getContext(), getArgNo() + 1, Kind)); } - /// \brief Remove a Attribute from an argument. + /// Remove attributes from an argument. void removeAttr(AttributeSet AS); void removeAttr(Attribute::AttrKind Kind) { removeAttr(AttributeSet::get(getContext(), getArgNo() + 1, Kind)); } - /// \brief Checks if an argument has a given attribute. + /// Check if an argument has a given attribute. bool hasAttribute(Attribute::AttrKind Kind) const; - /// \brief Method for support type inquiry through isa, cast, and - /// dyn_cast. + /// Method for support type inquiry through isa, cast, and dyn_cast. static inline bool classof(const Value *V) { return V->getValueID() == ArgumentVal; } diff --git a/lib/IR/Function.cpp b/lib/IR/Function.cpp index 05419aa3d2b..62e8717a0f1 100644 --- a/lib/IR/Function.cpp +++ b/lib/IR/Function.cpp @@ -52,8 +52,6 @@ void Argument::setParent(Function *parent) { Parent = parent; } -/// getArgNo - Return the index of this formal argument in its containing -/// function. For example in "void foo(int a, float b)" a is 0 and b is 1. unsigned Argument::getArgNo() const { const Function *F = getParent(); assert(F && "Argument is not in a function"); @@ -66,9 +64,6 @@ unsigned Argument::getArgNo() const { return ArgIdx; } -/// hasNonNullAttr - Return true if this argument has the nonnull attribute on -/// it in its containing function. Also returns true if at least one byte is -/// known to be dereferenceable and the pointer is in addrspace(0). bool Argument::hasNonNullAttr() const { if (!getType()->isPointerTy()) return false; if (getParent()->getAttributes(). @@ -80,8 +75,6 @@ bool Argument::hasNonNullAttr() const { return false; } -/// hasByValAttr - Return true if this argument has the byval attribute on it -/// in its containing function. bool Argument::hasByValAttr() const { if (!getType()->isPointerTy()) return false; return hasAttribute(Attribute::ByVal); @@ -97,8 +90,6 @@ bool Argument::hasSwiftErrorAttr() const { hasAttribute(getArgNo()+1, Attribute::SwiftError); } -/// \brief Return true if this argument has the inalloca attribute on it in -/// its containing function. bool Argument::hasInAllocaAttr() const { if (!getType()->isPointerTy()) return false; return hasAttribute(Attribute::InAlloca); @@ -129,54 +120,38 @@ uint64_t Argument::getDereferenceableOrNullBytes() const { return getParent()->getDereferenceableOrNullBytes(getArgNo()+1); } -/// hasNestAttr - Return true if this argument has the nest attribute on -/// it in its containing function. bool Argument::hasNestAttr() const { if (!getType()->isPointerTy()) return false; return hasAttribute(Attribute::Nest); } -/// hasNoAliasAttr - Return true if this argument has the noalias attribute on -/// it in its containing function. bool Argument::hasNoAliasAttr() const { if (!getType()->isPointerTy()) return false; return hasAttribute(Attribute::NoAlias); } -/// hasNoCaptureAttr - Return true if this argument has the nocapture attribute -/// on it in its containing function. bool Argument::hasNoCaptureAttr() const { if (!getType()->isPointerTy()) return false; return hasAttribute(Attribute::NoCapture); } -/// hasSRetAttr - Return true if this argument has the sret attribute on -/// it in its containing function. bool Argument::hasStructRetAttr() const { if (!getType()->isPointerTy()) return false; return hasAttribute(Attribute::StructRet); } -/// hasReturnedAttr - Return true if this argument has the returned attribute on -/// it in its containing function. bool Argument::hasReturnedAttr() const { return hasAttribute(Attribute::Returned); } -/// hasZExtAttr - Return true if this argument has the zext attribute on it in -/// its containing function. bool Argument::hasZExtAttr() const { return hasAttribute(Attribute::ZExt); } -/// hasSExtAttr Return true if this argument has the sext attribute on it in its -/// containing function. bool Argument::hasSExtAttr() const { return hasAttribute(Attribute::SExt); } -/// Return true if this argument has the readonly or readnone attribute on it -/// in its containing function. bool Argument::onlyReadsMemory() const { return getParent()->getAttributes(). hasAttribute(getArgNo()+1, Attribute::ReadOnly) || @@ -184,7 +159,6 @@ bool Argument::onlyReadsMemory() const { hasAttribute(getArgNo()+1, Attribute::ReadNone); } -/// addAttr - Add attributes to an argument. void Argument::addAttr(AttributeSet AS) { assert(AS.getNumSlots() <= 1 && "Trying to add more than one attribute set to an argument!"); @@ -194,7 +168,6 @@ void Argument::addAttr(AttributeSet AS) { getArgNo() + 1, B)); } -/// removeAttr - Remove attributes from an argument. void Argument::removeAttr(AttributeSet AS) { assert(AS.getNumSlots() <= 1 && "Trying to remove more than one attribute set from an argument!"); @@ -204,7 +177,6 @@ void Argument::removeAttr(AttributeSet AS) { getArgNo() + 1, B)); } -/// hasAttribute - Checks if an argument has a given attribute. bool Argument::hasAttribute(Attribute::AttrKind Kind) const { return getParent()->hasAttribute(getArgNo() + 1, Kind); } -- 2.40.0