NAME

Pod::Elemental::Element - a POD element

VERSION

version 0.091470

ATTRIBUTES

type

The type is a string giving a type for the element, like text or nonpod or command. These are generally the same as the event types from the event reader.

content

This is the textual content of the element, as in a Pod::Eventual event, but has its trailing newline chomped. In other words, this POD:

=head2 content

has a content of "content"

start_line

This attribute, which may or may not be set, indicates the line in the source document where the element began.

METHODS

as_hash

This returns a hashref describing the object.

as_string

This returns the element as a string, suitable for turning elements back into a document. Some elements, like a =over command, will stringify to include extra content like a =back command. In the case of elements with children, this method will include the stringified children as well.

as_debug_string

This method returns a string, like as_string, but is meant for getting an overview of the document structure, and is not suitable for reproducing a document. Its exact output is likely to change over time.

AUTHOR

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2009 by Ricardo SIGNES.

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