Scroll to navigation

PPI::Token::Pod(3pm) User Contributed Perl Documentation PPI::Token::Pod(3pm)

NAME

PPI::Token::Pod - Sections of POD in Perl documents

INHERITANCE

  PPI::Token::Pod
  isa PPI::Token
      isa PPI::Element

DESCRIPTION

A single "PPI::Token::Pod" object represents a complete section of POD documentation within a Perl document.

METHODS

This class provides some additional methods beyond those provided by its PPI::Token and PPI::Element parent classes.

merge @podtokens

The "merge" constructor takes a number of "PPI::Token::Pod" objects, and returns a new object that represents one combined POD block with the content of all of them.

Returns a new "PPI::Token::Pod" object, or "undef" on error.

lines

The "lines" method takes the string of POD and breaks it into lines, returning them as a list.

SUPPORT

See the support section in the main module.

AUTHOR

Adam Kennedy <adamk@cpan.org>

COPYRIGHT

Copyright 2001 - 2011 Adam Kennedy.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

2024-08-24 perl v5.38.2