|
|
| |
MooseX::App::Meta::Role::Class::Documentation(3) |
User Contributed Perl Documentation |
MooseX::App::Meta::Role::Class::Documentation(3) |
MooseX::App::Meta::Role::Class::Documentation - Meta class role for command
classes
This meta class role will automatically be applied to all command classes. This
documentation is only of interest if you intend to write plugins for
MooseX::App.
Read/set the short command description. Will be extracted from the Pod NAME or
ABSTRACT section if not set. Alternative this will be taken from the DistZilla
ABSTRACT tag.
Read/set the long command description. Will be extracted from the Pod
DESCRIPTION or OVERVIEW section if not set.
Read/set the long command usage. Will be extracted from the Pod SYNOPSIS or
USAGE section if not set. If these Pod sections are not defined the usage will
be autogenerated.
Checks if command_short_description is available
Checks if command_long_description is available
Checks if command_usage is available
Read/set the strict command flag. If strict is enabled the command will
terminate with an error message if superfluous/unknown positional parameters
are supplied. If disabled all extra parameters will be copied to the
extra_argv attribute.
The app_strict function in the app classes allows one to set this
option globally.
Parses the Pod from the command class.
Visit the GSP FreeBSD Man Page Interface. Output converted with ManDoc. |