Test::Inline::Extract - Extract relevant Pod sections from source


Test-Inline documentation  | view source Contained in the Test-Inline distribution.

Index


NAME

Top

Test::Inline::Extract - Extract relevant Pod sections from source code.

DESCRIPTION

Top

The Test::Inline::Extract package extracts content interesting to Test::Inline from source files.

METHODS

Top

new $file | \$source

The new constructor creates a new Extract object. It is passed either a file name from which the source code would be loaded, or a reference to a string that directly contains source code.

Returns a new Test::Inline::Extract object or undef on error.

elements

  my $elements = $Extract->elements;

The elements method extracts from the Pod any parts of the file that are relevant to the extraction and generation process of Test::Inline.

The elements will be either a package statements, or a section of inline unit tests. They will only be returned if there is at least one section of inline unit tests.

Returns a reference to an array of package strings and sections of inline unit tests. Returns false if there are no sections containing inline unit tests.

TO DO

Top

- For certain very complex cases, add a more intensive alternative parser based on PPI

SUPPORT

Top

See the main SUPPORT section.

AUTHOR

Top

Adam Kennedy <adamk@cpan.org>, http://ali.as/

COPYRIGHT

Top


Test-Inline documentation  | view source Contained in the Test-Inline distribution.