blob: f97969f6b4db83fa296683b109ee73f08f6c76f7 [file]
@node Texinfo@asis{::}TreeElement
@chapter Texinfo::TreeElement
@node Texinfo@asis{::}TreeElement NAME
@section Texinfo::TreeElement NAME
Texinfo::TreeElement - Texinfo tree element interface
@node Texinfo@asis{::}TreeElement SYNOPSIS
@section Texinfo::TreeElement SYNOPSIS
@verbatim
my $element = Texinfo::TreeElement::new({});
@end verbatim
@node Texinfo@asis{::}TreeElement NOTES
@section Texinfo::TreeElement NOTES
The Texinfo Perl module main purpose is to be used in @code{texi2any} to convert
Texinfo to other formats. There is no promise of API stability.
Note that this module could be removed at any time.
@node Texinfo@asis{::}TreeElement DESCRIPTION
@section Texinfo::TreeElement DESCRIPTION
@code{Texinfo::TreeElement::new} should be called on every Perl tree
elements created.
@node Texinfo@asis{::}TreeElement METHODS
@section Texinfo::TreeElement METHODS
@table @asis
@item $element = new($element_hash)
@anchor{Texinfo@asis{::}TreeElement $element = new($element_hash)}
@cindex @code{new}
Turns the @emph{$element_hash} element hash into a @code{Texinfo::TreeElement} object.
This function is called on all the tree elements created in Texinfo modules
codes. The call to @code{new} is mainly cosmetic, to mark where a new element is
created. It also allows to distinguish a Texinfo tree element from a hash.
@end table
@node Texinfo@asis{::}TreeElement SEE ALSO
@section Texinfo::TreeElement SEE ALSO
@ref{Texinfo@asis{::}Parser TEXINFO TREE}.
@node Texinfo@asis{::}TreeElement AUTHOR
@section Texinfo::TreeElement AUTHOR
Patrice Dumas.
@node Texinfo@asis{::}TreeElement COPYRIGHT AND LICENSE
@section Texinfo::TreeElement COPYRIGHT AND LICENSE
Copyright 2025- Free Software Foundation, Inc. See the source file for
all copyright years.
This library 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.