Class

Pod::SectionToAdd - describes a perl POD section. Used internally only, by Pod::Modifier.

Public Functions

new ( BASE = SCALAR|ARRAYREF SECTION => SCALAR SECTION_INDEX => SCALAR OPTIONAL => SCALAR (optional) )>

Creates a new object for an existing section in POD of BASE.

Arguments

BASE => base

SCALAR The full path to perl module containing section of the POD. Or, ARRAYREF list of full paths of perl modules containing required section.

SECTION => section

SCALAR Name of the head (1) section.

SECTION_INDEX => index

SCALAR Attribute to set position of insertion for this section.

Return Value

Reference to class instance

Preconditions

The base files specified must exist and be readable, specified section must exist as head(1) section.

getSectionIndex()

Returns the SECTION_INDEX attribute of current PodSection object (returns undef unless defined).

getBaseFile()

Returns the BASE attribute for PodSection object.

getSectionName()

Returns the SECTION attribute of current PodSection object (returns undef unless defined).