improve code comments
This commit is contained in:
+1
-1
@@ -22,7 +22,7 @@ module Gollum
|
|||||||
|
|
||||||
#########################################################################
|
#########################################################################
|
||||||
#
|
#
|
||||||
# Private
|
# Internal Methods
|
||||||
#
|
#
|
||||||
#########################################################################
|
#########################################################################
|
||||||
|
|
||||||
|
|||||||
+17
-5
@@ -19,7 +19,9 @@ module Gollum
|
|||||||
@blob.name rescue nil
|
@blob.name rescue nil
|
||||||
end
|
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
|
attr_reader :path
|
||||||
|
|
||||||
# Public: The raw contents of the page.
|
# Public: The raw contents of the page.
|
||||||
@@ -65,6 +67,8 @@ module Gollum
|
|||||||
end
|
end
|
||||||
|
|
||||||
# Public: The Grit::Commit version of the page.
|
# Public: The Grit::Commit version of the page.
|
||||||
|
#
|
||||||
|
# Returns the Grit::Commit.
|
||||||
attr_reader :version
|
attr_reader :version
|
||||||
|
|
||||||
# Public: All of the versions that have touched this Page.
|
# 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.
|
# Convert a format Symbol into an extension String.
|
||||||
#
|
#
|
||||||
# format - The format Symbol.
|
# format - The format Symbol.
|
||||||
@@ -100,6 +101,17 @@ module Gollum
|
|||||||
end
|
end
|
||||||
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.
|
# Find a page in the given Gollum repo.
|
||||||
#
|
#
|
||||||
# name - The human or canonical String page name to find.
|
# name - The human or canonical String page name to find.
|
||||||
|
|||||||
+5
-1
@@ -71,14 +71,18 @@ module Gollum
|
|||||||
|
|
||||||
#########################################################################
|
#########################################################################
|
||||||
#
|
#
|
||||||
# Private
|
# Internal Methods
|
||||||
#
|
#
|
||||||
#########################################################################
|
#########################################################################
|
||||||
|
|
||||||
# The Grit::Repo associated with this wiki.
|
# The Grit::Repo associated with this wiki.
|
||||||
|
#
|
||||||
|
# Returns the Grit::Repo.
|
||||||
attr_reader :repo
|
attr_reader :repo
|
||||||
|
|
||||||
# The String path to the Git repository that holds the Gollum site.
|
# The String path to the Git repository that holds the Gollum site.
|
||||||
|
#
|
||||||
|
# Returns the String path.
|
||||||
attr_reader :path
|
attr_reader :path
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
Reference in New Issue
Block a user