NAME

XML::Elemental::Document - a generic document object.

DESCRIPTION

XML::Elemental::Document is a subclass of XML::Elemental::Node that can be used with the Elemental parser to represent the document (root) node.

METHODS

XML::Elemental::Document->new

Parameterless constructor. Returns an instance of the object.

$doc->contents([\@children])

Returns an ordered array reference of direct sibling objects. In the case of the document object it will return 0 to 1 elements. Returns a reference to an empty array if the element does not have any siblings. If a parameter is passed all the direct siblings are (re)set.

$doc->root_element;

Returns the root element of the document. This a connivence method that is the equivalent of:

  $doc->contents->[0];
    

$doc->root

Inherited from XML::Elemental::Node, returns a reference to itself.

$doc->ancestors

Inherited from XML::Elemental::Node, returns undef. The document object never has ancestors.

$doc->in($element)

Inherited from XML::Elemental::Node, returns undef. The document object is always the root of the tree.

AUTHOR & COPYRIGHT

Please see the XML::Elemental manpage for author, copyright, and license information.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 27:

=begin without a target?

Around line 41:

'=item' outside of any '=over'

Around line 74:

You forgot a '=back' before '=head1'

Around line 81:

'=end' without a target?