Update doxygen description for `WriteBitcodeToFile()` API (NFC)
authorMehdi Amini <mehdi.amini@apple.com>
Mon, 18 Jul 2016 21:29:24 +0000 (21:29 +0000)
committerMehdi Amini <mehdi.amini@apple.com>
Mon, 18 Jul 2016 21:29:24 +0000 (21:29 +0000)
llvm-svn: 275917

llvm/include/llvm/Bitcode/ReaderWriter.h

index 76a60a0..53deaae 100644 (file)
@@ -94,8 +94,11 @@ namespace llvm {
   /// Value in \c M.  These will be reconstructed exactly when \a M is
   /// deserialized.
   ///
-  /// If \c EmitSummaryIndex, emit the module's summary index (currently
-  /// for use in ThinLTO optimization).
+  /// If \c Index is supplied, the bitcode will contain the summary index
+  /// (currently for use in ThinLTO optimization).
+  ///
+  /// \p GenerateHash enables hashing the Module and including the hash in the
+  /// bitcode (currently for use in ThinLTO incremental build).
   void WriteBitcodeToFile(const Module *M, raw_ostream &Out,
                           bool ShouldPreserveUseListOrder = false,
                           const ModuleSummaryIndex *Index = nullptr,