Scroll to navigation

App::Spec::Pod(3) User Contributed Perl Documentation App::Spec::Pod(3)

NAME

App::Spec::Pod - Generates Pod from App::Spec objects

SYNOPSIS

    my $generator = App::Spec::Pod->new(
        spec => $appspec,
    );
    my $pod = $generator->generate;

METHODS

    my $pod = $generator->generate;
    
    $pod->markup(text => \$abstract);
    

Applies markup defined in the spec to the text argument.

    my $option_string = "Options:\n\n" . $self->options2pod(
        options => $options,
    );
    
    my $param_string = "Parameters:\n\n" . $self->params2pod(
        parameters => $parameters,
    );
    
Generates pod for subcommands recursively

    my @pod = $self->subcommand_pod(
        previous => [@previous_subcmds],
        commands => $subcmds,
    );
    
    my $pod = $self->swim2pod($swim);
    

Converts Swim markup to Pod. See Swim.

Accessor for App::Spec object
2025-03-26 perl v5.42.1