[llvm-commits] [llvm] r165512 - /llvm/trunk/include/llvm/User.h

[Michael Ilseman]

Author: milseman
Date: Tue Oct  9 12:05:59 2012
New Revision: 165512

URL: http://llvm.org/viewvc/llvm-project?rev=165512&view=rev
Log:
More descriptive, doxygen-ed comments

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

Modified: llvm/trunk/include/llvm/User.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/User.h?rev=165512&r1=165511&r2=165512&view=diff
==============================================================================
--- llvm/trunk/include/llvm/User.h (original)
+++ llvm/trunk/include/llvm/User.h Tue Oct  9 12:05:59 2012
@@ -118,6 +118,8 @@
   inline op_iterator       op_end()         { return OperandList+NumOperands; }
   inline const_op_iterator op_end()   const { return OperandList+NumOperands; }
 
+  /// Convenience iterator for directly iterating over the Values in the
+  /// OperandList
   class value_op_iterator : public std::iterator<std::forward_iterator_tag,
                                                  Value*> {
     op_iterator OI;
@@ -131,7 +133,7 @@
       return !operator==(x);
     }
 
-    // Iterator traversal: forward iteration only
+    /// Iterator traversal: forward iteration only
     value_op_iterator &operator++() {          // Preincrement
       ++OI;
       return *this;
@@ -140,7 +142,7 @@
       value_op_iterator tmp = *this; ++*this; return tmp;
     }
 
-    // Retrieve a pointer to the current User.
+    /// Retrieve a pointer to the current Value.
     Value *operator*() const {
       return *OI;
     }