Skip to content

Commit

Permalink
Rewrite doc to use of =head2
Browse files Browse the repository at this point in the history
  • Loading branch information
michal-josef-spacek committed Jan 1, 2024
1 parent c494087 commit 72909d9
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 25 deletions.
1 change: 1 addition & 0 deletions Changes
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
0.03
- Add tests.
- Move bugtracker to github.
- Rewrite doc to use of =head2.
- Update Module::Install to 1.21 version.
- Update copyright years.

Expand Down
34 changes: 21 additions & 13 deletions Files.pm
Original file line number Diff line number Diff line change
Expand Up @@ -112,33 +112,41 @@ METS::Files - Class for METS files manipulation.
=head1 METHODS
=over 8
=head2 C<new>
=item C<new()>
my $obj = METS::Files->new(
'mets_data' => $mets_data,
);
Constructor.
Constructor.
=over 8
=item * C<mets_data>
METS data.
Parameter is required.
Default value is undef.
METS data.
Parameter is required.
=back
=item C<get_use_files($use)>
Returns instance of object.
=head2 C<get_use_files>
Get "USE" files.
Returns array with files.
my @files = $obj->get_use_files($use);
=item C<get_use_types()>
Get "USE" files defined by C<$use> variable.
Get "USE" types.
Returns array with types.
Returns array with files.
=back
=head2 C<get_use_types>
my @types = $obj->get_use_types;
Get "USE" types.
Returns array with types.
=head1 ERRORS
Expand Down
36 changes: 24 additions & 12 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,34 @@ SYNOPSIS
my @types = $obj->get_use_types;

METHODS
"new()"
Constructor.
"new"
my $obj = METS::Files->new(
'mets_data' => $mets_data,
);

Constructor.

* "mets_data"

METS data.

* "mets_data"
Parameter is required.

METS data.
Parameter is required.
Default value is undef.
Returns instance of object.

"get_use_files"
my @files = $obj->get_use_files($use);

Get "USE" files defined by $use variable.

Returns array with files.

"get_use_types"
my @types = $obj->get_use_types;

"get_use_files($use)"
Get "USE" files.
Returns array with files.
Get "USE" types.

"get_use_types()"
Get "USE" types.
Returns array with types.
Returns array with types.

ERRORS
new():
Expand Down

0 comments on commit 72909d9

Please sign in to comment.