improve comment.

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

diff --git a/include/llvm/Bytecode/Writer.h b/include/llvm/Bytecode/Writer.h
index 4db6d1366485155c3719cf59d96a3e3542fbca6e..0517d8c84be59c0c0dca411e8841f99f098b68d5 100644 (file)
--- a/include/llvm/Bytecode/Writer.h
+++ b/include/llvm/Bytecode/Writer.h
@@ -28,6 +28,10 @@
 
 namespace llvm {
   class Module;
+  /// WriteBytecodeToFile - Write the specified module to the specified output
+  /// stream.  If compress is set to true, try to use compression when writing
+  /// out the file.  This throws an std::string if there is an error writing
+  /// the file.
   void WriteBytecodeToFile(const Module *M, std::ostream &Out,
                            bool compress = true);
 } // End llvm namespace