Skip to content

Commit

Permalink
add basic synopsis showing subclassing or using an existing formatter
Browse files Browse the repository at this point in the history
  • Loading branch information
haarg authored and khwilliamson committed Aug 18, 2024
1 parent cf4e306 commit a0a3c55
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion lib/Pod/Simple.pod
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,19 @@ Pod::Simple - framework for parsing Pod

=head1 SYNOPSIS

TODO
# using an existing formatter
use Pod::Simple::XHTML;
my $parser = Pod::Simple::XHTML->new;
$parser->parse_file('path/to/file.pod');

# creating a new formatter
package Pod::Simple::SomeFormatter;
use parent qw(Pod::Simple);
sub _handle_element_start {
my ($parser, $element_name, $attr_hash_r) = @_;
...
}
...

=head1 DESCRIPTION

Expand Down

0 comments on commit a0a3c55

Please sign in to comment.