Add comments per CL code review.

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

diff --git a/lib/Bytecode/Reader/Reader.h b/lib/Bytecode/Reader/Reader.h
index 49d81733b8a12a41fd1109882b929232f676abfb..72a6040366403950cfe797eb47d10e3bd2e15a17 100644 (file)
--- a/lib/Bytecode/Reader/Reader.h
+++ b/lib/Bytecode/Reader/Reader.h
@@ -67,6 +67,11 @@ public:
   /// @brief The type used for a vector of potentially abstract types
   typedef std::vector<PATypeHolder> TypeListTy;
 
+  /// This structure is only used when a bytecode file is compressed.
+  /// As bytecode is being decompressed, the memory buffer might need
+  /// to be reallocated. The buffer allocation is handled in a callback 
+  /// and this structure is needed to retain information across calls
+  /// to the callback.
   /// @brief An internal buffer object used for handling decompression
   struct BufferInfo {
     char* buff;
@@ -246,8 +251,7 @@ protected:
 /// @name Data
 /// @{
 private:
-  BufferInfo bi;      ///< Buffer info for decompression
-
+  BufferInfo bi;       ///< Buffer info for decompression
   BufPtr MemStart;     ///< Start of the memory buffer
   BufPtr MemEnd;       ///< End of the memory buffer
   BufPtr BlockStart;   ///< Start of current block being parsed