1PPI::Token::Pod(3)    User Contributed Perl Documentation   PPI::Token::Pod(3)
2
3
4

NAME

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

INHERITANCE

9         PPI::Token::Pod
10         isa PPI::Token
11             isa PPI::Element
12

DESCRIPTION

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

METHODS

18       This class provides some additional methods beyond those provided by
19       its PPI::Token and PPI::Element parent classes.
20
21       Got any ideas for more methods? Submit a report to rt.cpan.org!
22
23       merge @podtokens
24
25       The "merge" constructor takes a number of "PPI::Token::Pod" objects,
26       and returns a new object that represents one combined POD block with
27       the content of all of them.
28
29       Returns a new "PPI::Token::Pod" object, or "undef" on error.
30
31       lines
32
33       The "lines" method takes the string of POD and breaks it into lines,
34       returning them as a list.
35

SUPPORT

37       See the support section in the main module.
38

AUTHOR

40       Adam Kennedy <adamk@cpan.org>
41

43       Copyright 2001 - 2006 Adam Kennedy.
44
45       This program is free software; you can redistribute it and/or modify it
46       under the same terms as Perl itself.
47
48       The full text of the license can be found in the LICENSE file included
49       with this module.
50
51
52
53perl v5.8.8                       2006-09-23                PPI::Token::Pod(3)
Impressum