From: Chris Lattner <sabre@nondot.org>
Date: Sun, 14 May 2006 19:10:22 +0000 (+0000)
Subject: improve comment.
X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=c3bb700f36f32279f1cef2660a69eb6fa5d2a63e;p=oota-llvm.git

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 4db6d136648..0517d8c84be 100644
--- 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