[llvm-commits] [llvm] r54210 - /llvm/trunk/include/llvm/BasicBlock.h

[Matthijs Kooijman]

Author: matthijs
Date: Wed Jul 30 07:53:14 2008
New Revision: 54210

URL: http://llvm.org/viewvc/llvm-project?rev=54210&view=rev
Log:
Document BasicBlock::Create.

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

Modified: llvm/trunk/include/llvm/BasicBlock.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/BasicBlock.h?rev=54210&r1=54209&r2=54210&view=diff

==============================================================================
--- llvm/trunk/include/llvm/BasicBlock.h (original)
+++ llvm/trunk/include/llvm/BasicBlock.h Wed Jul 30 07:53:14 2008
@@ -74,7 +74,9 @@
   typedef InstListType::iterator                              iterator;
   typedef InstListType::const_iterator                  const_iterator;
 
-  // allocate space for exactly zero operands
+  /// Create - Creates a new BasicBlock. If the Parent parameter is specified,
+  /// the basic block is automatically inserted at either the end of the
+  /// function (if InsertBefore is 0), or before the specified basic block.
   static BasicBlock *Create(const std::string &Name = "", Function *Parent = 0,
                             BasicBlock *InsertBefore = 0) {
     return new BasicBlock(Name, Parent, InsertBefore);