Skip to content

Commit

Permalink
enhance find_and_pack documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kentfredric committed Jul 10, 2015
1 parent 8b7c869 commit 43f22d6
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.pod
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,20 @@ Returns a hash detailing operations and results:
fail => [ { module => ..., file => ..., error => ... }, ... ],
}

=head3 options:

=over 4

=item C<$root_dir> - The base path where the assets to be packed are stored

=item C<$namespace_prefix> - A module name like C<My::Asset> which will be used as the parent for generated modules.

=item C<$libdir> B<[optional]> - The target directory to generate the Modules in.

Defaults to C<./lib>.

=back

=head1 SEE ALSO

=over 4
Expand Down
14 changes: 14 additions & 0 deletions lib/Asset/Pack.pm
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,20 @@ Returns a hash detailing operations and results:
fail => [ { module => ..., file => ..., error => ... }, ... ],
}
=head3 options:
=over 4
=item C<$root_dir> - The base path where the assets to be packed are stored
=item C<$namespace_prefix> - A module name like C<My::Asset> which will be used as the parent for generated modules.
=item C<$libdir> B<[optional]> - The target directory to generate the Modules in.
Defaults to C<./lib>.
=back
=cut

sub find_and_pack {
Expand Down

0 comments on commit 43f22d6

Please sign in to comment.