![]() |
![]()
| ![]() |
![]()
NAMEMDOM::Dumper - Dumping of MDOM treesSYNOPSIS# Load a document my $Module = MDOM::Document->new( 'MyMakefile' ); # Create the dumper my $Dumper = MDOM::Dumper->new( $Module ); # Dump the document $Dumper->print; DESCRIPTIONThe MDOM trees in MDOM are quite complex, and getting a dump of their structure for development and debugging purposes is important.This module provides that functionality. The process is relatively simple. Create a dumper object with a particular set of options, and then call one of the dump methods to generate the dump content itself. METHODSnew $Element, param => value, ...The "new" constructor creates a dumper, and takes as argument a single MDOM::Element object of any type to serve as the root of the tree to be dumped, and a number of key->value parameters to control the output format of the Dumper. Details of the parameters are listed below.Returns a new "MDOM::Dumper" object, or "undef" if the constructor is not passed a correct MDOM::Element root object.
Returns as for the internal print function. stringThe "string" method generates the dump and provides it as a single string.Returns a string or undef if there is an error while generating the dump. listThe "list" method generates the dump and provides it as a raw list, without trailing newlines.Returns a list or the null list if there is an error while generation the dump. SUPPORTSee the support section in the main module.AUTHORAdam Kennedy <adamk@cpan.org>Yichun "agentzh" Zhang "<agentzh@gmail.com>" COPYRIGHTCopyright 2001 - 2006 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.
|