/ 
MooseX-App-1.43
River stage two • 32 direct dependents • 58 total dependents
/ MooseX::App::Meta::Role::Class::Documentation

NAME

MooseX::App::Meta::Role::Class::Documentation - Meta class role for command classes

DESCRIPTION

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.

ACCESSORS

command_short_description

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.

command_long_description

Read/set the long command description. Will be extracted from the Pod DESCRIPTION or OVERVIEW section if not set.

command_usage

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.

command_short_description_predicate

Checks if command_short_description is available

command_long_description_predicate

Checks if command_long_description is available

command_usage_predicate

Checks if command_usage is available

command_strict

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.

METHODS

_build_command_pod

Parses the Pod from the command class.