From: Zachary Stevens <zts@cryptocracy.com>
Date: Sun, 6 Dec 2009 22:57:42 +0000 (+0000)
Subject: Added some more POD for the ::Git::Object classes.
X-Git-Tag: 0.000003~3^2
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=c19af0d014d4b658b4815b95958ffcf4461a5788;p=catagits%2FGitalist.git

Added some more POD for the ::Git::Object classes.
---

diff --git a/lib/Gitalist/Git/Object.pm b/lib/Gitalist/Git/Object.pm
index 544b473..c1a5194 100644
--- a/lib/Gitalist/Git/Object.pm
+++ b/lib/Gitalist/Git/Object.pm
@@ -75,6 +75,25 @@ class Gitalist::Git::Object {
 
 } # end class
 
+__END__
+
+=head1 NAME
+
+Gitalist::Git::Object - Model of a git object.
+
+=head1 SYNOPSIS
+
+    my $object = Project->get_object($sha1);
+
+=head1 DESCRIPTION
+
+Abstract base class for git objects.
+
+
+=head1 ATTRIBUTES
+
+
+=head1 METHODS
 
 
 =head1 AUTHORS
diff --git a/lib/Gitalist/Git/Object/Blob.pm b/lib/Gitalist/Git/Object/Blob.pm
index 59061b2..7561d2c 100644
--- a/lib/Gitalist/Git/Object/Blob.pm
+++ b/lib/Gitalist/Git/Object/Blob.pm
@@ -13,9 +13,20 @@ __END__
 
 Gitalist::Git::Object::Blob
 
+=head1 SYNOPSIS
+
+    my $blob = Project->get_object($blob_sha1);
+
 =head1 DESCRIPTION
 
-Gitalist::Git::Object::Blob.
+Represents a blob object in a git repository.
+Subclass of C<Gitalist::Git::Object>.
+
+
+=head1 ATTRIBUTES
+
+
+=head1 METHODS
 
 =head1 AUTHORS
 
diff --git a/lib/Gitalist/Git/Object/Commit.pm b/lib/Gitalist/Git/Object/Commit.pm
index 817c99f..a6261fa 100644
--- a/lib/Gitalist/Git/Object/Commit.pm
+++ b/lib/Gitalist/Git/Object/Commit.pm
@@ -194,9 +194,44 @@ __END__
 
 Gitalist::Git::Object::Commit
 
+=head1 SYNOPSIS
+
+    my $commit = Project->get_object($commit_sha1);
+
 =head1 DESCRIPTION
 
-Gitalist::Git::Object::Commit.
+Represents a commit object in a git repository.
+Subclass of C<Gitalist::Git::Object>.
+
+
+=head1 ATTRIBUTES
+
+=head2 committer
+
+=head2 committed_time
+
+=head2 author
+
+=head2 authored_time
+
+=head2 comment
+
+=head2 tree_sha1
+
+=head2 parents
+
+=head2 parent_sha1
+
+=head2 parent_sha1s
+
+
+=head1 METHODS
+
+=head2 get_patch
+
+=head2 diff
+
+=head2 blame
 
 =head1 AUTHORS
 
diff --git a/lib/Gitalist/Git/Object/HasTree.pm b/lib/Gitalist/Git/Object/HasTree.pm
index 9f75a1e..501576a 100644
--- a/lib/Gitalist/Git/Object/HasTree.pm
+++ b/lib/Gitalist/Git/Object/HasTree.pm
@@ -40,9 +40,22 @@ __END__
 
 Gitalist::Git::Object::HasTree
 
+=head1 SYNOPSIS
+
+    my $tree = Project->get_object($tree_sha1);
+
 =head1 DESCRIPTION
 
-Gitalist::Git::Object::HasTree.
+Role for objects which have a tree - C<Commit> and C<Tree> objects.
+
+
+=head1 ATTRIBUTES
+
+=head2 tree
+
+
+=head1 METHODS
+
 
 =head1 AUTHORS
 
diff --git a/lib/Gitalist/Git/Object/Tag.pm b/lib/Gitalist/Git/Object/Tag.pm
index 3511fb3..766145e 100644
--- a/lib/Gitalist/Git/Object/Tag.pm
+++ b/lib/Gitalist/Git/Object/Tag.pm
@@ -16,15 +16,33 @@ class Gitalist::Git::Object::Tag extends Gitalist::Git::Object {
 
 __END__
 
-__END__
-
 =head1 NAME
 
 Gitalist::Git::Object::Tag
 
+=head1 SYNOPSIS
+
+    my $tag = Project->get_object($tag_sha1);
+
 =head1 DESCRIPTION
 
-Gitalist::Git::Object::Tag.
+Represents a tag object in a git repository.
+Subclass of C<Gitalist::Git::Object>.
+
+
+=head1 ATTRIBUTES
+
+=head2 tag
+
+=head2 tagger
+
+=head2 tagged_time
+
+=head2 object
+
+
+=head1 METHODS
+
 
 =head1 AUTHORS
 
diff --git a/lib/Gitalist/Git/Object/Tree.pm b/lib/Gitalist/Git/Object/Tree.pm
index e771ec5..ff01acd 100644
--- a/lib/Gitalist/Git/Object/Tree.pm
+++ b/lib/Gitalist/Git/Object/Tree.pm
@@ -14,14 +14,25 @@ class Gitalist::Git::Object::Tree
 
 __END__
 
-
 =head1 NAME
 
 Gitalist::Git::Object::Tree
 
+=head1 SYNOPSIS
+
+    my $tree = Project->get_object($tree_sha1);
+
 =head1 DESCRIPTION
 
-Gitalist::Git::Object::Tree.
+Represents a tree object in a git repository.
+Subclass of C<Gitalist::Git::Object>.
+
+
+=head1 ATTRIBUTES
+
+
+=head1 METHODS
+
 
 =head1 AUTHORS