From 470ffe448d33492229be52154e12e6216ac5300e Mon Sep 17 00:00:00 2001
From: Jason Orendorff <jason.orendorff@gmail.com>
Date: Tue, 21 Nov 2017 12:00:21 -0600
Subject: [PATCH] A few more comments.

---
 src/write.rs | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/write.rs b/src/write.rs
index 100f388..ee30c60 100644
--- a/src/write.rs
+++ b/src/write.rs
@@ -6,9 +6,23 @@ use index::InMemoryIndex;
 use tmp::TmpDir;
 use byteorder::{LittleEndian, WriteBytesExt};
 
+/// Writer for saving an index to a binary file.
+///
+/// The first 8 bytes of the index file contain the offset of the table of
+/// contents, in bytes. Then come the main entries, all stored back-to-back
+/// with no particular metadata.
+///
+
+/// An index file has two parts. The main part of the file is a sequence of
+/// entries, stored back-to-back; the
 pub struct IndexFileWriter {
+    /// The number of bytes written so far.
     offset: u64,
+
+    /// The open file we're writing to.
     writer: BufWriter<File>,
+
+    /// The table of contents for this file.
     contents_buf: Vec<u8>
 }
 
@@ -38,6 +52,7 @@ impl IndexFileWriter {
         self.contents_buf.extend(bytes);
     }
 
+    /// Finish writing the index file and close it.
     pub fn finish(mut self) -> io::Result<()> {
         let contents_start = self.offset;
         self.writer.write_all(&self.contents_buf)?;