Add in the first step of the multiple pointer support. This adds in support to the...

[oota-llvm.git] / include / llvm / Object / Binary.h

diff --git a/include/llvm/Object/Binary.h b/include/llvm/Object/Binary.h
index 81cdd32a73e3d32b2f8bf09b397dc4214e6766f2..baed81827d0c5be47c8e57f5b255a63899ee61bb 100644 (file)
--- a/include/llvm/Object/Binary.h
+++ b/include/llvm/Object/Binary.h
@@ -26,8 +26,8 @@ namespace object {
 
 class Binary {
 private:
-  Binary(); // = delete
-  Binary(const Binary &other); // = delete
+  Binary() LLVM_DELETED_FUNCTION;
+  Binary(const Binary &other) LLVM_DELETED_FUNCTION;
 
   unsigned int TypeID;
 
@@ -88,7 +88,14 @@ public:
   }
 };
 
+/// @brief Create a Binary from Source, autodetecting the file type.
+///
+/// @param Source The data to create the Binary from. Ownership is transferred
+///        to Result if successful. If an error is returned, Source is destroyed
+///        by createBinary before returning.
+/// @param Result A pointer to the resulting Binary if no error occured.
 error_code createBinary(MemoryBuffer *Source, OwningPtr<Binary> &Result);
+
 error_code createBinary(StringRef Path, OwningPtr<Binary> &Result);
 
 }