From 8b878b3e1f31d7e9bd82e882c07a2371f459faf4 Mon Sep 17 00:00:00 2001
From: Tom Preston-Werner <tom@mojombo.com>
Date: Sat, 17 Apr 2010 19:42:54 -0400
Subject: [PATCH] improve code comments

---
 lib/gollum/file.rb |  2 +-
 lib/gollum/page.rb | 22 +++++++++++++++++-----
 lib/gollum/wiki.rb |  6 +++++-
 3 files changed, 23 insertions(+), 7 deletions(-)

diff --git a/lib/gollum/file.rb b/lib/gollum/file.rb
index 44d8237f..30e1acda 100644
--- a/lib/gollum/file.rb
+++ b/lib/gollum/file.rb
@@ -22,7 +22,7 @@ module Gollum
 
     #########################################################################
     #
-    # Private
+    # Internal Methods
     #
     #########################################################################
 
diff --git a/lib/gollum/page.rb b/lib/gollum/page.rb
index d450f7ee..ed1cd5d0 100644
--- a/lib/gollum/page.rb
+++ b/lib/gollum/page.rb
@@ -19,7 +19,9 @@ module Gollum
       @blob.name rescue nil
     end
 
-    # Public: The String full path of the page.
+    # Public: The path of the page within the repo.
+    #
+    # Returns the String path.
     attr_reader :path
 
     # Public: The raw contents of the page.
@@ -65,6 +67,8 @@ module Gollum
     end
 
     # Public: The Grit::Commit version of the page.
+    #
+    # Returns the Grit::Commit.
     attr_reader :version
 
     # Public: All of the versions that have touched this Page.
@@ -76,13 +80,10 @@ module Gollum
 
     #########################################################################
     #
-    # Private
+    # Class Methods
     #
     #########################################################################
 
-    # The Grit::Commit version of the page.
-    attr_writer :version
-
     # Convert a format Symbol into an extension String.
     #
     # format - The format Symbol.
@@ -100,6 +101,17 @@ module Gollum
       end
     end
 
+    #########################################################################
+    #
+    # Internal Methods
+    #
+    #########################################################################
+
+    # Set the Grit::Commit version of the page.
+    #
+    # Returns nothing.
+    attr_writer :version
+
     # Find a page in the given Gollum repo.
     #
     # name    - The human or canonical String page name to find.
diff --git a/lib/gollum/wiki.rb b/lib/gollum/wiki.rb
index 2e7ee575..1c23f3ff 100644
--- a/lib/gollum/wiki.rb
+++ b/lib/gollum/wiki.rb
@@ -71,14 +71,18 @@ module Gollum
 
     #########################################################################
     #
-    # Private
+    # Internal Methods
     #
     #########################################################################
 
     # The Grit::Repo associated with this wiki.
+    #
+    # Returns the Grit::Repo.
     attr_reader :repo
 
     # The String path to the Git repository that holds the Gollum site.
+    #
+    # Returns the String path.
     attr_reader :path
   end
 end
\ No newline at end of file