Improve documentation.

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

diff --git a/include/llvm-c/BitWriter.h b/include/llvm-c/BitWriter.h
index bc5699f1a9ad4c28156f8e738dc91135e960e6f8..008ff9f2c1063a84f4b5a2ca60e05214da139f5b 100644 (file)
--- a/include/llvm-c/BitWriter.h
+++ b/include/llvm-c/BitWriter.h
@@ -28,7 +28,8 @@ extern "C" {
 
 /*===-- Operations on modules ---------------------------------------------===*/
 
-/* Writes a module to an open file descriptor. Returns 0 on success. */ 
+/* Writes a module to an open file descriptor. Returns 0 on success.
+   Closes the Handle. Use dup first if this is not what you want. */ 
 int LLVMWriteBitcodeToFileHandle(LLVMModuleRef M, int Handle);
 
 /* Writes a module to the specified path. Returns 0 on success. */