[llvm] r275917 - Update doxygen description for `WriteBitcodeToFile()` API (NFC)

[Mehdi Amini via llvm-commits]

Author: mehdi_amini
Date: Mon Jul 18 16:29:24 2016
New Revision: 275917

URL: http://llvm.org/viewvc/llvm-project?rev=275917&view=rev
Log:
Update doxygen description for `WriteBitcodeToFile()` API (NFC)

Modified:
    llvm/trunk/include/llvm/Bitcode/ReaderWriter.h

Modified: llvm/trunk/include/llvm/Bitcode/ReaderWriter.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Bitcode/ReaderWriter.h?rev=275917&r1=275916&r2=275917&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Bitcode/ReaderWriter.h (original)
+++ llvm/trunk/include/llvm/Bitcode/ReaderWriter.h Mon Jul 18 16:29:24 2016
@@ -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,