[llvm-commits] CVS: llvm/lib/Bytecode/Reader/Reader.h

[Reid Spencer]

Changes in directory llvm/lib/Bytecode/Reader:

Reader.h updated: 1.16 -> 1.17
---
Log message:

Add comments per CL code review.


---
Diffs of the changes:  (+6 -2)

Index: llvm/lib/Bytecode/Reader/Reader.h
diff -u llvm/lib/Bytecode/Reader/Reader.h:1.16 llvm/lib/Bytecode/Reader/Reader.h:1.17
--- llvm/lib/Bytecode/Reader/Reader.h:1.16	Sat Nov  6 17:17:23 2004
+++ llvm/lib/Bytecode/Reader/Reader.h	Sun Nov  7 12:19:00 2004
@@ -67,6 +67,11 @@
   /// @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 @@
 /// @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