[llvm-commits] [llvm] r172960 - /llvm/trunk/include/llvm/IR/Argument.h

[Michael Gottesman]

Author: mgottesman
Date: Sat Jan 19 23:03:39 2013
New Revision: 172960

URL: http://llvm.org/viewvc/llvm-project?rev=172960&view=rev
Log:
Doxygenified Argument.h and performed some copy editing of the documentation.

Modified:
    llvm/trunk/include/llvm/IR/Argument.h

Modified: llvm/trunk/include/llvm/IR/Argument.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/IR/Argument.h?rev=172960&r1=172959&r2=172960&view=diff
==============================================================================
--- llvm/trunk/include/llvm/IR/Argument.h (original)
+++ llvm/trunk/include/llvm/IR/Argument.h Sat Jan 19 23:03:39 2013
@@ -7,7 +7,7 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// This file declares the Argument class. 
+// This file declares the Argument class.
 //
 //===----------------------------------------------------------------------===//
 
@@ -24,11 +24,14 @@
 template<typename ValueSubClass, typename ItemParentClass>
   class SymbolTableListTraits;
 
-/// A class to represent an incoming formal argument to a Function. An argument
-/// is a very simple Value. It is essentially a named (optional) type. When used
-/// in the body of a function, it represents the value of the actual argument
-/// the function was called with.
-/// @brief LLVM Argument representation  
+/// \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
+/// for a specific function. When used in the body of said function, the
+/// argument of course represents the value of the actual argument that the
+/// function was called with.
 class Argument : public Value, public ilist_node<Argument> {
   virtual void anchor();
   Function *Parent;
@@ -37,50 +40,52 @@
   void setParent(Function *parent);
 
 public:
-  /// Argument ctor - If Function argument is specified, this argument is
-  /// inserted at the end of the argument list for the function.
+  /// \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 = 0);
 
   inline const Function *getParent() const { return Parent; }
   inline       Function *getParent()       { return 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. 
+  /// \brief 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;
-  
-  /// hasByValAttr - Return true if this argument has the byval attribute on it
-  /// in its containing function.
+
+  /// \brief Return true if this argument has the byval attribute on it in its
+  /// containing function.
   bool hasByValAttr() const;
-  
-  /// getParamAlignment - If this is a byval argument, return its alignment.
+
+  /// \brief If this is a byval argument, return its alignment.
   unsigned getParamAlignment() const;
 
-  /// hasNestAttr - Return true if this argument has the nest attribute on
-  /// it in its containing function.
+  /// \brief Return true if this argument has the nest attribute on it in its
+  /// containing function.
   bool hasNestAttr() const;
 
-  /// hasNoAliasAttr - Return true if this argument has the noalias attribute on
-  /// it in its containing function.
+  /// \brief Return true if this argument has the noalias attribute on it in its
+  /// containing function.
   bool hasNoAliasAttr() const;
-  
-  /// hasNoCaptureAttr - Return true if this argument has the nocapture
-  /// attribute on it in its containing function.
+
+  /// \brief Return true if this argument has the nocapture attribute on it in
+  /// its containing function.
   bool hasNoCaptureAttr() const;
-  
-  /// hasStructRetAttr - Return true if this argument has the sret attribute on
-  /// it in its containing function.
+
+  /// \brief Return true if this argument has the sret attribute on it in its
+  /// containing function.
   bool hasStructRetAttr() const;
 
-  /// addAttr - Add a Attribute to an argument
+  /// \brief Add a Attribute to an argument.
   void addAttr(Attribute);
-  
-  /// removeAttr - Remove a Attribute from an argument
+
+  /// \brief Remove a Attribute from an argument.
   void removeAttr(Attribute);
 
-  /// classof - Methods for support type inquiry through isa, cast, and
-  /// dyn_cast:
-  ///
+  /// \brief Method for support type inquiry through isa, cast, and
+  /// dyn_cast.
   static inline bool classof(const Value *V) {
     return V->getValueID() == ArgumentVal;
   }