lib/Pod/InputObjects.pm

6 # This file is part of "PodParser". PodParser is free software;
37 This module defines some basic input objects used by B<Pod::Parser> when
95 This object corresponds to an input source or stream of POD
121 This is a class method that constructs a C<Pod::InputSource> object and
160 This method gets/sets the name of the input source (usually a filename).
248 This is a class method that constructs a C<Pod::Paragraph> object and
310 This method will return the corresponding text of the paragraph.
325 This method will return the I<raw> text of the POD paragraph, exactly
376 This method will get/set the corresponding parse-tree of the paragraph's text.
440 This is a class method that constructs a C<Pod::InteriorSequence> object
609 This method will return the I<raw> text of the POD interior sequence,
668 This method will get/set the corresponding parse-tree of the interior
706 This method performs any necessary cleanup for the interior-sequence.
730 This object corresponds to a tree of parsed POD text. As POD text is
748 This is a class method that constructs a C<Pod::Parse_tree> object and
775 This method gets/sets the top node of the parse-tree. If no arguments are
799 This method gets/sets the children of the top node in the parse-tree.
819 This method prepends the given text or parse-tree to the current parse-tree.
847 This method appends the given text or parse-tree to the current parse-tree.
879 This method will return the I<raw> text of the POD parse-tree
913 This method performs any necessary cleanup for the parse-tree.