The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-weavedoc-0.001
River stage zero No dependents
1 ++
/ weavedoc

NAME

weavedoc

VERSION

version 0.001

SYNOPSIS

    weavedoc [--license <license>] [--version <version>] [--author <author>] <file>
    weavedoc -h|--help

DESCRIPTION

This program takes a path to a Perl file and runs it through Pod::Weaver, the pluggable POD pre-processor, and then displaying the documentation (like perldoc).

ARGUMENTS

<file>

A path to a Perl file to weave and display.

OPTIONS

license

    weavedoc --license Perl_5 Module.pm

The name of a license to declare in the resulting POD. Should be a valid subclass of Software::License. Some examples are: Perl_5, GPL_1, GPL_2, GPL_3, Artistic. A more-complete list is provided in the documentation for Software::License.

version

    weavedoc --version 1.23 Module.pm

The version of the input Perl file, to be used if necessary in the POD.

author

    weavedoc --author 'Doug Bell <doug@example.com>' Module.pm

The author of the Perl file. May be specified multiple times for multiple authors. You can include an e-mail address in <> brackets.

CONFIGURATION

weavedoc expects a Pod::Weaver configuration file (weaver.ini) in the current directory.

SEE ALSO

Pod::Weaver
Dist::Zilla

TODO

  • -i in-place mode to munge the code in-place like Dist::Zilla does

  • --no-strip to disable stripping code. This is the default in -i mode.

  • --config <file> to specify a path to a Pod::Weaver config file.

  • Use a default configuration when no weaver.ini configuration file found in the current directory.

  • Search parent directories for weaver.ini.

  • Determine the --version automatically from the input code.

  • -M <formatter_class> option to specify formatter class, like perldoc has.

AUTHOR

Doug Bell <preaction@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Doug Bell.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.