[llvm-commits] [llvm] r51170 - /llvm/trunk/include/llvm/Instructions.h

[Dan Gohman]

Author: djg
Date: Thu May 15 18:35:32 2008
New Revision: 51170

URL: http://llvm.org/viewvc/llvm-project?rev=51170&view=rev
Log:
Update comments based on Duncan's feedback.

Modified:
    llvm/trunk/include/llvm/Instructions.h

Modified: llvm/trunk/include/llvm/Instructions.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Instructions.h?rev=51170&r1=51169&r2=51170&view=diff

==============================================================================
--- llvm/trunk/include/llvm/Instructions.h (original)
+++ llvm/trunk/include/llvm/Instructions.h Thu May 15 18:35:32 2008
@@ -404,7 +404,7 @@
   /// getIndexedType - Returns the type of the element that would be loaded with
   /// a load instruction with the specified parameters.
   ///
-  /// A null type is returned if the indices are invalid for the specified
+  /// Null is returned if the indices are invalid for the specified
   /// pointer type.
   ///
   static const Type *getIndexedType(const Type *Ptr,
@@ -497,7 +497,7 @@
   /// getIndexedType - Returns the type of the element that would be loaded with
   /// a load instruction with the specified parameters.
   ///
-  /// A null type is returned if the indices are invalid for the specified
+  /// Null is returned if the indices are invalid for the specified
   /// pointer type.
   ///
   template<typename InputIterator>
@@ -1495,8 +1495,8 @@
 //                                ExtractValueInst Class
 //===----------------------------------------------------------------------===//
 
-/// ExtractValueInst - This instruction extracts a value
-/// from an aggregate value
+/// ExtractValueInst - This instruction extracts a struct member or array
+/// element value from an aggregate value.
 ///
 class ExtractValueInst : public Instruction {
   ExtractValueInst(const ExtractValueInst &EVI);
@@ -1526,7 +1526,7 @@
   /// getIndexedType - Returns the type of the element that would be extracted
   /// with an extractvalue instruction with the specified parameters.
   ///
-  /// A null type is returned if the indices are invalid for the specified
+  /// Null is returned if the indices are invalid for the specified
   /// pointer type.
   ///
   static const Type *getIndexedType(const Type *Agg,
@@ -1549,10 +1549,10 @@
       return getIndexedType(Ptr, (Value *const*)0, NumIdx);
   }
 
-  /// Constructors - Create a extractvalue instruction with a base pointer an
-  /// list of indices.  The first ctor can optionally insert before an existing
-  /// instruction, the second appends the new instruction to the specified
-  /// BasicBlock.
+  /// Constructors - Create a extractvalue instruction with a base aggregate
+  /// value and a list of indices.  The first ctor can optionally insert before
+  /// an existing instruction, the second appends the new instruction to the
+  /// specified BasicBlock.
   template<typename InputIterator>
   inline ExtractValueInst(Value *Agg, InputIterator IdxBegin, 
                           InputIterator IdxEnd,
@@ -1620,7 +1620,7 @@
   /// getIndexedType - Returns the type of the element that would be extracted
   /// with an extractvalue instruction with the specified parameters.
   ///
-  /// A null type is returned if the indices are invalid for the specified
+  /// Null is returned if the indices are invalid for the specified
   /// pointer type.
   ///
   template<typename InputIterator>
@@ -1676,8 +1676,8 @@
 //                                InsertValueInst Class
 //===----------------------------------------------------------------------===//
 
-/// InsertValueInst - This instruction extracts a value
-/// from an aggregate value
+/// InsertValueInst - This instruction inserts a struct field of array element
+/// value into an aggregate value.
 ///
 class InsertValueInst : public Instruction {
   InsertValueInst(const InsertValueInst &IVI);
@@ -1705,21 +1705,21 @@
     setName(Name);
   }
 
-  /// Constructors - Create a insertvalue instruction with a base pointer an
-  /// list of indices.  The first ctor can optionally insert before an existing
-  /// instruction, the second appends the new instruction to the specified
-  /// BasicBlock.
+  /// Constructors - Create a insertvalue instruction with a base aggregate
+  /// value, a value to insert, and a list of indices.  The first ctor can
+  /// optionally insert before an existing instruction, the second appends
+  /// the new instruction to the specified BasicBlock.
   template<typename InputIterator>
   inline InsertValueInst(Value *Agg, Value *Val, InputIterator IdxBegin, 
-                          InputIterator IdxEnd,
-                          unsigned Values,
-                          const std::string &Name,
-                          Instruction *InsertBefore);
+                         InputIterator IdxEnd,
+                         unsigned Values,
+                         const std::string &Name,
+                         Instruction *InsertBefore);
   template<typename InputIterator>
   inline InsertValueInst(Value *Agg, Value *Val,
-                          InputIterator IdxBegin, InputIterator IdxEnd,
-                          unsigned Values,
-                          const std::string &Name, BasicBlock *InsertAtEnd);
+                         InputIterator IdxBegin, InputIterator IdxEnd,
+                         unsigned Values,
+                         const std::string &Name, BasicBlock *InsertAtEnd);
 
   /// Constructors - These two constructors are convenience methods because one
   /// and two index insertvalue instructions are so common.