More Pod

[catagits/Gitalist.git] / lib / Gitalist / Git / CollectionOfRepositories / FromListOfDirectories.pm

diff --git a/lib/Gitalist/Git/CollectionOfRepositories/FromListOfDirectories.pm b/lib/Gitalist/Git/CollectionOfRepositories/FromListOfDirectories.pm
index ba66185..4f3383c 100644 (file)
--- a/lib/Gitalist/Git/CollectionOfRepositories/FromListOfDirectories.pm
+++ b/lib/Gitalist/Git/CollectionOfRepositories/FromListOfDirectories.pm
@@ -11,7 +11,7 @@ class Gitalist::Git::CollectionOfRepositories::FromListOfDirectories with Gitali
         is => 'ro',
         required => 1,
     );
-    has repos_by_name => (
+    has _repos_by_name => (
         isa => HashRef[NonEmptySimpleStr],
         is => 'ro',
         lazy_build => 1,
@@ -21,7 +21,7 @@ class Gitalist::Git::CollectionOfRepositories::FromListOfDirectories with Gitali
         },
     );
 
-    method _build_repos_by_name {
+    method _build__repos_by_name {
         { map { basename($_) => $_ } $self->repos->flatten };
     }
 
@@ -32,3 +32,41 @@ class Gitalist::Git::CollectionOfRepositories::FromListOfDirectories with Gitali
 }                               # end class
 
 1;
+
+=head1 NAME
+
+Gitalist::Git::CollectionOfRepositories::FromListOfDirectories - Model of a collection of git repositories
+
+=head1 SYNOPSIS
+
+    my $collection = Gitalist::Git::CollectionOfRepositories::FromListOfDirectories->new( repos => [qw/
+        /path/to/repos1
+        /path/to/repos2
+    /] );
+    my $repository_list = $collection->repositories;
+    my $first_repository = $repository_list->[0];
+    my $named_repository = $repo->get_repository('Gitalist');
+
+=head1 DESCRIPTION
+
+This class provides an abstraction for a list of Repository directories.
+
+=head1 ATTRIBUTES
+
+=head2 repos (C<< ArrayRef[NonEmptySimpleStr] >>)
+
+A list of git repository directories
+
+=head1 SEE ALSO
+
+L<Gitalist::Git::CollectionOfRepositories>, L<Gitalist::Git::Repository>
+
+=head1 AUTHORS
+
+See L<Gitalist> for authors.
+
+=head1 LICENSE
+
+See L<Gitalist> for the license.
+
+=cut