-
- GitHub
- GitLab
- Bitbucket
-
By logging in you accept
our terms of service
and privacy policy
Turns comment above functions to pod.
A util for generating pod documentation from comments.
This package contains:
comment2pod (commandline util)App::CommentToPod - module containing utils for converting text to podDist::Zilla::Plugin::CommentToPod - distzilla plugin which enables
comment2pod during builds.# expect distzilla to be installed
PERL5LIB=lib dzil test
PERL5LIB=lib dzil build
cpanm comment2pod-0.00*.tar.gz
Concider the following file
# Hello::Printer provide some utils
# foo
package Hello::Printer;
use strict;
use warnings;
# hello() prints hello
sub hello {
...
}
# wow() prints wow
sub wow {
...
}
1;
The following command:
$ cat Printer.pm | ./bin/comment2pod
Will generate the following (to stdout)
=pod
=encoding utf8
=head1 NAME
Hello::Printer
=head1 SYNOPSIS
Hello::Printer provide some utils
foo
=cut
=head2 Methods
=cut
# Hello::Printer provide some utils
# foo
package Hello::Printer;
use strict;
use warnings;
=over 12
=item C<hello>
hello() prints hello
=back
=cut
sub hello {
...
}
=over 12
=item C<wow>
wow() prints wow
=back
=cut
sub wow {
...
}
1;
The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.
Learn more →Something wrong with this page? Make a suggestion
Export .ABOUT file for this package
Last synced: 2019-09-13 07:50:03 UTC
Login to resync this project