fix a comment bug Reid noticed

[oota-llvm.git] / include / llvm / Argument.h

diff --git a/include/llvm/Argument.h b/include/llvm/Argument.h
index 3c38cdea037137f66b99ede2edc5cf12b5b0b181..8776a488aadc36526965b25d348d7eedffa4f410 100644 (file)
--- a/include/llvm/Argument.h
+++ b/include/llvm/Argument.h
@@ -1,14 +1,13 @@
 //===-- llvm/Argument.h - Definition of the Argument class ------*- C++ -*-===//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
 // This file was developed by the LLVM research group and is distributed under
 // the University of Illinois Open Source License. See LICENSE.TXT for details.
-// 
+//
 //===----------------------------------------------------------------------===//
 //
-// This file defines the Argument class, which represents an incoming formal
-// argument to a Function.
+// This file declares the Argument class. 
 //
 //===----------------------------------------------------------------------===//
 
@@ -23,6 +22,11 @@ template<typename SC> struct ilist_traits;
 template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
          typename SubClass> 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  
 class Argument : public Value {  // Defined in the Function.cpp file
   Function *Parent;
 
@@ -37,11 +41,13 @@ public:
   /// Argument ctor - If Function argument is specified, this argument is
   /// inserted at the end of the argument list for the function.
   ///
-  Argument(const Type *Ty, const std::string &Name = "", Function *F = 0);
+  explicit Argument(const Type *Ty,
+                    const std::string &Name = "",
+                    Function *F = 0);
 
   inline const Function *getParent() const { return Parent; }
   inline       Function *getParent()       { return Parent; }
- 
+
   // getNext/Prev - Return the next or previous argument in the list.
         Argument *getNext()       { return Next; }
   const Argument *getNext() const { return Next; }
@@ -49,6 +55,9 @@ public:
   const Argument *getPrev() const { return Prev; }
 
   virtual void print(std::ostream &OS) const;
+  void print(std::ostream *OS) const {
+    if (OS) print(*OS);
+  }
 
   /// classof - Methods for support type inquiry through isa, cast, and
   /// dyn_cast: