Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add basic synopsis showing subclassing or using an existing formatter #169

Merged
merged 1 commit into from
Aug 18, 2024
Merged

add basic synopsis showing subclassing or using an existing formatter #169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion lib/Pod/Simple.pod
View file
Open in desktop
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
Loading