[llvm-commits] [llvm] r50768 - /llvm/trunk/include/llvm-c/BitWriter.h

[Gordon Henriksen]

Author: gordon
Date: Tue May  6 14:17:01 2008
New Revision: 50768

URL: http://llvm.org/viewvc/llvm-project?rev=50768&view=rev
Log:
Improve documentation.

Modified:
    llvm/trunk/include/llvm-c/BitWriter.h

Modified: llvm/trunk/include/llvm-c/BitWriter.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm-c/BitWriter.h?rev=50768&r1=50767&r2=50768&view=diff

==============================================================================
--- llvm/trunk/include/llvm-c/BitWriter.h (original)
+++ llvm/trunk/include/llvm-c/BitWriter.h Tue May  6 14:17:01 2008
@@ -28,7 +28,8 @@
 
 /*===-- 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. */