Steve Price > App-Framework-1.06 > App::Framework::Feature::Pod

Download:
App-Framework-1.06.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 1.002   Source  

NAME ^

App::Framework::Feature::Pod - Application documentation

SYNOPSIS ^

  # Data feature is loaded by default as if the script contained:
  use App::Framework '+Pod' ;

DESCRIPTION ^

Used by the application framework to create pod-based man pages and help.

ADDITIONAL COMMAND LINE OPTIONS

This feature adds the following additional command line options to any application:

-help - show help

Displays brief help message then exits

-man - show full man pages

Displays the application's full man pages then exits

-man-dev - show full developer man pages

Displays the application's full developer man pages then exits. Developer man pages contain extra information and is intended for the application developer (rather than the end user).

-pod - show man pages as pod [developer use]

Outputs the full pod text.

CONSTRUCTOR

new([%args])

Create a new Pod.

The %args are specified as they would be in the set method (see "Fields").

CLASS METHODS

init_class([%args])

Initialises the Pod object class variables.

OBJECT METHODS

application_entry()

Called by the application framework at the start of the application.

This method checks for the user specifying any of the options described above (see "ADDITIONAL COMMAND LINE OPTIONS") and handles them if so.

pod([$developer])

Return full pod of application

If the optional $developer flag is set, returns application developer biased information

Pod([%args])

Alias to "pod"

pod_head([$developer])

Return pod heading of application

If the optional $developer flag is set, returns application developer biased information

pod_options([$developer])

Return pod of options of application

If the optional $developer flag is set, returns application developer biased information

pod_args([$developer])

Return pod of args of application

If the optional $developer flag is set, returns application developer biased information

pod_description([$developer])

Return pod of description of application

If the optional $developer flag is set, returns application developer biased information

get_synopsis()

Check to ensure synopsis is set. If not, set based on application name and any Args settings

DIAGNOSTICS ^

Setting the debug flag to level 1 prints out (to STDOUT) some debug messages, setting it to level 2 prints out more verbose messages.

AUTHOR ^

Steve Price <sdprice at cpan.org>

BUGS ^

None that I know of!

syntax highlighting: