Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xml::mini::treecomponent(3pm) [debian man page]

XML::Mini::TreeComponent(3pm)				User Contributed Perl Documentation			     XML::Mini::TreeComponent(3pm)

NAME

       XML::Mini::TreeComponent - Perl implementation of the XML::Mini TreeComponent API.

SYNOPSIS

       Don't use this class - only presents an interface for other derived classes.

DESCRIPTION

       This class is only to be used as a base class for others.

       It presents the minimal interface we can expect from any component in the XML hierarchy.

       All methods of this base class simply return NULL except a little default functionality included in the parent() method.

       Warning: This class is not to be instatiated.  Derive and override.

   parent [NEWPARENT]
       The parent() method is used to get/set the element's parent.

       If the NEWPARENT parameter is passed, sets the parent to NEWPARENT (NEWPARENT must be an instance of a class derived from
       XML::MiniTreeComponent)

       Returns a reference to the parent XML::MiniTreeComponent if set, NULL otherwise.

   toString [DEPTH]
       Return a stringified version of the XML representing this component and all sub-components

   dump
       Debugging aid, dump returns a nicely formatted dump of the current structure of the XML::Mini::TreeComponent-derived object.

AUTHOR

       Copyright (C) 2002-2008 Patrick Deegan, Psychogenic Inc.

       Programs that use this code are bound to the terms and conditions of the GNU GPL (see the LICENSE file).  If you wish to include these
       modules in non-GPL code, you need prior written authorisation from the authors.

       This library is released under the terms of the GNU GPL version 3, making it available only for free programs ("free" here being used in
       the sense of the GPL, see http://www.gnu.org for more details).	Anyone wishing to use this library within a proprietary or otherwise non-
       GPLed program MUST contact psychogenic.com to acquire a distinct license for their application.	This approach encourages the use of free
       software while allowing for proprietary solutions that support further development.

   LICENSE
	   XML::Mini::TreeComponent module, part of the XML::Mini XML parser/generator package.
	   Copyright (C) 2002-2008 Patrick Deegan
	   All rights reserved

	   XML::Mini is free software: you can redistribute it and/or modify
	   it under the terms of the GNU General Public License as published by
	   the Free Software Foundation, either version 3 of the License, or
	   (at your option) any later version.

	   XML::Mini is distributed in the hope that it will be useful,
	   but WITHOUT ANY WARRANTY; without even the implied warranty of
	   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	   GNU General Public License for more details.

	   You should have received a copy of the GNU General Public License
	   along with XML::Mini.  If not, see <http://www.gnu.org/licenses/>.

       Official XML::Mini site: http://minixml.psychogenic.com

       Contact page for author available on http://www.psychogenic.com/

SEE ALSO

       XML::Mini, XML::Mini::Document, XML::Mini::Element

       http://minixml.psychogenic.com

perl v5.10.0							    2008-02-10					     XML::Mini::TreeComponent(3pm)

Check Out this Related Man Page

mxmldoc(1)							   Michael Sweet							mxmldoc(1)

NAME

       mxmldoc - mini-xml documentation generator

SYNOPSIS

       mxmldoc --no-output [ filename.xml ] source file(s) ]
       mxmldoc	[  --footer  footerfile ] [ --header headerfile ] [ --intro introfile ] [ --section section ] [ --title title ] [ filename.xml ] [
       source file(s) ] > filename.html
       mxmldoc [ --footer footerfile ] [ --framed basename ] [ --header headerfile ] [ --intro introfile ] [ --section section ] [ --title title ]
       [ filename.xml ] [ source file(s) ]
       mxmldoc --man manpage [ --footer footerfile ] [ --header headerfile ] [ --intro introfile ] [ --section section ] [ --title title ] [ file-
       name.xml ] [ source file(s) ] > filename.man

DESCRIPTION

       mxmldoc scans the specified C and C++ source files to produce an XML representation of globally	accessible  classes,  constants,  enumera-
       tions,  functions, structures, typedefs, unions, and variables - the XML file is updated as necessary. By default, a HTML representation of
       the XML file is written to the standard output.	Use the --no-output option to disable the HTML output.

       Man page source can be generated using the --man option.

       If no source files are specified then the current XML file is converted to the standard output.

       In general, any C or C++ source code is handled by mxmldoc, however it was specifically written to handle code with documentation  that	is
       formatted according to the CUPS Developer Guide which is available at "http://www.cups.org/documentation.php".

OPTIONS

       --footer footerfile
	    Inserts the specified file at the bottom of the output documentation.

       --framed basename
	    Created HTML documentation using frames - one for the table-of-contents and one for the body.

       --header headerfile
	    Inserts the specified file at the top of the output documentation.

       --intro introfile
	    Inserts the specified file before the table of contents.

       --man manpage
	    Generated a man page instead of HTML documentation.

       --no-output
	    Disables generation of documentation on the standard output.

       --section section
	    Sets the section/keywords in the output documentation.

       --title title
	    Sets the title of the output documentation.

SEE ALSO

       mxml(3), Mini-XML Programmers Manual, http://www.minixml.org/

COPYRIGHT

       Copyright 2003-2008 by Michael Sweet.

26 January 2008 						     Mini-XML								mxmldoc(1)
Man Page