From c4fc92dfaaeccf9dad59381c5a0a774b9b565be0 Mon Sep 17 00:00:00 2001 From: Tom Preston-Werner Date: Sat, 17 Apr 2010 19:01:43 -0400 Subject: [PATCH] use new-style Public: instead of Private: to denote API --- lib/gollum/file.rb | 8 ++++---- lib/gollum/page.rb | 30 +++++++++++++++--------------- lib/gollum/wiki.rb | 17 ++++++++--------- 3 files changed, 27 insertions(+), 28 deletions(-) diff --git a/lib/gollum/file.rb b/lib/gollum/file.rb index d98cd47c..44d8237f 100644 --- a/lib/gollum/file.rb +++ b/lib/gollum/file.rb @@ -1,6 +1,6 @@ module Gollum class File - # Initialize a file. + # Public: Initialize a file. # # wiki - The Gollum::Wiki in question. # @@ -10,14 +10,14 @@ module Gollum @blob = nil end - # The raw contents of the page. + # Public: The raw contents of the page. # # Returns the String data. def raw_data @blob.data rescue nil end - # The Grit::Commit version of the file. + # Public: The Grit::Commit version of the file. attr_reader :version ######################################################################### @@ -26,7 +26,7 @@ module Gollum # ######################################################################### - # Private: Find a file in the given Gollum repo. + # Find a file in the given Gollum repo. # # name - The full String path. # version - The String version ID to find. diff --git a/lib/gollum/page.rb b/lib/gollum/page.rb index e9377132..d450f7ee 100644 --- a/lib/gollum/page.rb +++ b/lib/gollum/page.rb @@ -2,7 +2,7 @@ module Gollum class Page VALID_PAGE_RE = /^(.+)\.(md|mkdn?|mdown|markdown|textile|rdoc|org|re?st(\.txt)?|asciidoc|pod|\d)$/i - # Initialize a page. + # Public: Initialize a page. # # wiki - The Gollum::Wiki in question. # @@ -12,31 +12,31 @@ module Gollum @blob = nil end - # The on-disk filename of the page. + # Public: The on-disk filename of the page. # # Returns the String name. def name @blob.name rescue nil end - # The String full path of the page. + # Public: The String full path of the page. attr_reader :path - # The raw contents of the page. + # Public: The raw contents of the page. # # Returns the String data. def raw_data @blob.data rescue nil end - # The formatted contents of the page. + # Public: The formatted contents of the page. # # Returns the String data. def formatted_data GitHub::Markup.render(@blob.name, @blob.data) rescue nil end - # The format of the page. + # Public: The format of the page. # # Returns the Symbol format of the page. One of: # [ :markdown | :textile | :rdoc | :org | :rest | :asciidoc | :pod | @@ -64,10 +64,10 @@ module Gollum end end - # The Grit::Commit version of the page. + # Public: The Grit::Commit version of the page. attr_reader :version - # All of the versions that have touched this Page. + # Public: All of the versions that have touched this Page. # # Returns an Array of Grit::Commit. def versions @@ -80,10 +80,10 @@ module Gollum # ######################################################################### - # Private: The Grit::Commit version of the page. + # The Grit::Commit version of the page. attr_writer :version - # Private: Convert a format Symbol into an extension String. + # Convert a format Symbol into an extension String. # # format - The format Symbol. # @@ -100,7 +100,7 @@ module Gollum end end - # Private: 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. # version - The String version ID to find. @@ -116,7 +116,7 @@ module Gollum end end - # Private: Find a page in a given tree. + # Find a page in a given tree. # # tree - The Grit::Tree in which to look. # name - The canonical String page name. @@ -144,7 +144,7 @@ module Gollum return nil # nothing was found end - # Private: Populate this Page with information from the Blob. + # Populate this Page with information from the Blob. # # blob - The Grit::Blob that contains the info. # path - The String directory path of the page file. @@ -156,7 +156,7 @@ module Gollum self end - # Private: The full directory path for the given tree. + # The full directory path for the given tree. # # treemap - The Hash treemap containing parentage information. # tree - The Grit::Tree for which to compute the path. @@ -170,7 +170,7 @@ module Gollum end end - # Private: Compare the canonicalized versions of the two names. + # Compare the canonicalized versions of the two names. # # name - The human or canonical String page name. # filename - the String filename on disk (including extension). diff --git a/lib/gollum/wiki.rb b/lib/gollum/wiki.rb index 28d53778..2e7ee575 100644 --- a/lib/gollum/wiki.rb +++ b/lib/gollum/wiki.rb @@ -1,6 +1,6 @@ module Gollum class Wiki - # Initialize a new Gollum Repo. + # Public: Initialize a new Gollum Repo. # # repo - The String path to the Git repository that holds the Gollum site. # @@ -10,7 +10,7 @@ module Gollum @repo = Grit::Repo.new(path) end - # Get the formatted page for a given page name. + # Public: Get the formatted page for a given page name. # # name - The human or canonical String page name of the wiki page. # version - The String version ID to find (default: "master"). @@ -20,7 +20,7 @@ module Gollum Page.new(self).find(name, version) end - # Get the static file for a given name. + # Public: Get the static file for a given name. # # name - The full String pathname to the file. # version - The String version ID to find (default: "master"). @@ -30,7 +30,7 @@ module Gollum File.new(self).find(name, version) end - # Write a new version of a page to the Gollum repo root. + # Public: Write a new version of a page to the Gollum repo root. # # name - The String name of the page. # data - The new String contents of the page. @@ -50,8 +50,8 @@ module Gollum index.commit(commit[:message], [parent], actor) end - # Update an existing page with new content. The location of the page - # inside the repository and the page's format will not change. + # Public: Update an existing page with new content. The location of the + # page inside the repository and the page's format will not change. # # page - The Gollum::Page to update. # data - The new String contents of the page. @@ -75,11 +75,10 @@ module Gollum # ######################################################################### - # Private: The Grit::Repo associated with this wiki. + # The Grit::Repo associated with this wiki. attr_reader :repo - # Private: The String path to the Git repository that holds the Gollum - # site. + # The String path to the Git repository that holds the Gollum site. attr_reader :path end end \ No newline at end of file