From 38f009d6d0aa35b13d19575611db1c724a9d1a5b Mon Sep 17 00:00:00 2001 From: scott Chacon Date: Tue, 13 Nov 2007 07:36:50 -0800 Subject: updated a bunch of the documentation --- doc/classes/Git/Object/AbstractObject.html | 114 +++++++------- doc/classes/Git/Object/Blob.html | 23 +-- doc/classes/Git/Object/Commit.html | 241 +++++++++++++++++++++++++++-- doc/classes/Git/Object/Tag.html | 40 +---- doc/classes/Git/Object/Tree.html | 142 +++++++++++++++-- 5 files changed, 439 insertions(+), 121 deletions(-) (limited to 'doc/classes/Git/Object') diff --git a/doc/classes/Git/Object/AbstractObject.html b/doc/classes/Git/Object/AbstractObject.html index 10d0080..222bc67 100644 --- a/doc/classes/Git/Object/AbstractObject.html +++ b/doc/classes/Git/Object/AbstractObject.html @@ -86,14 +86,14 @@

Methods

- contents   - contents_array   - diff   - grep   - log   - new   - setup   - to_s   + contents   + contents_array   + diff   + grep   + log   + new   + setup   + to_s  
@@ -143,24 +143,24 @@

Public Class methods

-
- +
+

[Source]

-
+ onclick="toggleCode('M000136-source');return false;">[Source]

+
-# File lib/git/object.rb, line 13
+# File lib/git/object.rb, line 14
       def initialize(base, sha)
         @base = base
-        @sha = sha
+        @sha = sha.to_s
         @size = @base.lib.object_size(@sha)
         setup
       end
@@ -171,21 +171,21 @@
 
       

Public Instance methods

-
- +
+

[Source]

-
+ onclick="toggleCode('M000137-source');return false;">[Source]

+
-# File lib/git/object.rb, line 20
+# File lib/git/object.rb, line 21
       def contents
         @base.lib.object_contents(@sha)
       end
@@ -194,21 +194,21 @@
         
-
- +
+

[Source]

-
+ onclick="toggleCode('M000138-source');return false;">[Source]

+
-# File lib/git/object.rb, line 24
+# File lib/git/object.rb, line 25
       def contents_array
         self.contents.split("\n")
       end
@@ -217,21 +217,21 @@
         
-
- +
+

[Source]

-
+ onclick="toggleCode('M000142-source');return false;">[Source]

+
-# File lib/git/object.rb, line 42
+# File lib/git/object.rb, line 43
       def diff(objectish)
         Git::Diff.new(@base, @sha, objectish)
       end
@@ -240,21 +240,21 @@
         
-
- +
+

[Source]

-
+ onclick="toggleCode('M000141-source');return false;">[Source]

+
-# File lib/git/object.rb, line 36
+# File lib/git/object.rb, line 37
       def grep(string, path_limiter = nil, opts = {})
         default = {:object => @sha, :path_limiter => path_limiter}
         grep_options = default.merge(opts)
@@ -265,21 +265,21 @@
         
-
- +
+

[Source]

-
+ onclick="toggleCode('M000143-source');return false;">[Source]

+
-# File lib/git/object.rb, line 46
+# File lib/git/object.rb, line 47
       def log(count = 30)
         Git::Log.new(@base, count).object(@sha)
       end
@@ -288,21 +288,21 @@
         
-
- +
+

[Source]

-
+ onclick="toggleCode('M000139-source');return false;">[Source]

+
-# File lib/git/object.rb, line 28
+# File lib/git/object.rb, line 29
       def setup
         raise NotImplementedError
       end
@@ -311,21 +311,21 @@
         
-
- +
+

[Source]

-
+ onclick="toggleCode('M000140-source');return false;">[Source]

+
-# File lib/git/object.rb, line 32
+# File lib/git/object.rb, line 33
       def to_s
         @sha
       end
diff --git a/doc/classes/Git/Object/Blob.html b/doc/classes/Git/Object/Blob.html
index a3fcb39..453a324 100644
--- a/doc/classes/Git/Object/Blob.html
+++ b/doc/classes/Git/Object/Blob.html
@@ -88,7 +88,7 @@
       

Methods

- setup   + new  
@@ -108,25 +108,26 @@
-

Public Instance methods

+

Public Class methods

-
- +
+

[Source]

-
+ onclick="toggleCode('M000145-source');return false;">[Source]

+
-# File lib/git/object.rb, line 54
-      def setup
-        @type = 'blob'
+# File lib/git/object.rb, line 56
+      def initialize(base, sha, mode = nil)
+        super(base, sha)
+        @mode = mode
       end
 
diff --git a/doc/classes/Git/Object/Commit.html b/doc/classes/Git/Object/Commit.html index 2f1e595..3be4f27 100644 --- a/doc/classes/Git/Object/Commit.html +++ b/doc/classes/Git/Object/Commit.html @@ -88,7 +88,16 @@

Methods

- setup   + author   + author_date   + committer   + committer_date   + date   + diff_parent   + gtree   + message   + parent   + parents  
@@ -110,23 +119,235 @@

Public Instance methods

-
- +
+
+

+git author +

[Source]

-
+ onclick="toggleCode('M000130-source');return false;">[Source]

+
-# File lib/git/object.rb, line 66
-      def setup
-        @type = 'commit'
+# File lib/git/object.rb, line 143
+      def author     
+        check_commit
+        @author
+      end
+
+
+
+
+ +
+ + + + +
+

[Source]

+
+
+# File lib/git/object.rb, line 148
+      def author_date
+        author.date
+      end
+
+
+
+
+ +
+ + + + +
+

+git author +

+

[Source]

+
+
+# File lib/git/object.rb, line 153
+      def committer
+        check_commit
+        @committer
+      end
+
+
+
+
+ +
+ + + + +
+

[Source]

+
+
+# File lib/git/object.rb, line 158
+      def committer_date 
+        committer.date
+      end
+
+
+
+
+ +
+ + +
+ date() +
+ +
+

+Alias for committer_date +

+
+
+ +
+ + + + +
+

[Source]

+
+
+# File lib/git/object.rb, line 163
+      def diff_parent
+        diff(parent)
+      end
+
+
+
+
+ +
+ + + + +
+

[Source]

+
+
+# File lib/git/object.rb, line 127
+      def gtree
+        check_commit
+        Tree.new(@base, @tree)
+      end
+
+
+
+
+ +
+ + + + +
+

[Source]

+
+
+# File lib/git/object.rb, line 122
+      def message
+        check_commit
+        @message
+      end
+
+
+
+
+ +
+ + + + +
+

[Source]

+
+
+# File lib/git/object.rb, line 132
+      def parent
+        parents.first
+      end
+
+
+
+
+ +
+ + + + +
+

+array of all parent commits +

+

[Source]

+
+
+# File lib/git/object.rb, line 137
+      def parents
+        check_commit
+        @parents        
       end
 
diff --git a/doc/classes/Git/Object/Tag.html b/doc/classes/Git/Object/Tag.html index 260b4c4..799baaa 100644 --- a/doc/classes/Git/Object/Tag.html +++ b/doc/classes/Git/Object/Tag.html @@ -88,8 +88,7 @@

Methods

- new   - setup   + new  
@@ -124,21 +123,21 @@

Public Class methods

-
- +
+

[Source]

-
+ onclick="toggleCode('M000144-source');return false;">[Source]

+
-# File lib/git/object.rb, line 74
+# File lib/git/object.rb, line 190
       def initialize(base, sha, name)
         super(base, sha)
         @name = name
@@ -148,31 +147,6 @@
         
-

Public Instance methods

- -
- - - - -
-

[Source]

-
-
-# File lib/git/object.rb, line 79
-      def setup
-        @type = 'tag'
-      end
-
-
-
-
-
diff --git a/doc/classes/Git/Object/Tree.html b/doc/classes/Git/Object/Tree.html index 4d681e8..72a8a61 100644 --- a/doc/classes/Git/Object/Tree.html +++ b/doc/classes/Git/Object/Tree.html @@ -88,7 +88,13 @@

Methods

- setup   + blobs   + children   + files   + new   + subdirectories   + subtrees   + trees  
@@ -108,25 +114,141 @@
+

Public Class methods

+ +
+ + + + +
+

[Source]

+
+
+# File lib/git/object.rb, line 73
+      def initialize(base, sha, mode = nil)
+        super(base, sha)
+        @mode = mode
+      end
+
+
+
+
+

Public Instance methods

-
- +
+ + + + +
+

[Source]

+
+
+# File lib/git/object.rb, line 82
+      def blobs
+        check_tree
+        @blobs
+      end
+
+
+
+
+ +
+ + + + +
+

[Source]

+
+
+# File lib/git/object.rb, line 78
+      def children
+        blobs.merge(subtrees)
+      end
+
+
+
+
+ +
+ + +
+ files() +
+ +
+

+Alias for blobs +

+
+
+ +
+ + +
+ subdirectories() +
+ +
+

+Alias for trees +

+
+
+ +
+ + +
+ subtrees() +
+ +
+

+Alias for trees +

+
+
+ +
+

[Source]

-
+ onclick="toggleCode('M000150-source');return false;">[Source]

+
-# File lib/git/object.rb, line 60
-      def setup
-        @type = 'tree'
+# File lib/git/object.rb, line 88
+      def trees
+        check_tree
+        @trees
       end
 
-- cgit