Permalink
Browse files

Index/Entry.pm: Added documentation for index entries

  • Loading branch information...
1 parent a831d8a commit fb0c9a401b3aa50f0c5e3f98e55f5b3c481f6a3e @jacquesg committed Mar 6, 2014
Showing with 21 additions and 0 deletions.
  1. +5 −0 lib/Git/Raw/Index.pm
  2. +16 −0 lib/Git/Raw/Index/Entry.pm
View
@@ -54,6 +54,11 @@ Determine if the index contains entries representing file conflicts.
Remove all conflicts in the index (entries with a stage greater than 0).
+=head2 conflicts( )
+
+Retrieve index entries that represent a conflict. Returns a list of
+C<Git::Raw::Index::Entry> objects.
+
=head1 AUTHOR
Alessandro Ghedini <alexbio@cpan.org>
View
@@ -18,6 +18,22 @@ B<WARNING>: The API of this module is unstable and may change without warning
=head1 METHODS
+=head2 id( )
+
+Retrieve the id of the index entry as a string.
+
+=head2 path( )
+
+Retrieve the path of the index entry.
+
+=head2 size( )
+
+Retrieve the size of the index entry.
+
+=head2 stage( )
+
+Retrieve the stage number for the index entry.
+
=head1 AUTHOR
Alessandro Ghedini <alexbio@cpan.org>

0 comments on commit fb0c9a4

Please sign in to comment.