Document BasicBlock::Create.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@54210 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/include/llvm/BasicBlock.h b/include/llvm/BasicBlock.h
index 47478f2009a15994525129d911877d9b72fc4206..6614a93883080a582839b7de8c0ef59c01164b6e 100644 (file)
--- a/include/llvm/BasicBlock.h
+++ b/include/llvm/BasicBlock.h
@@ -74,7 +74,9 @@ public:
   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);