[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[6053] Parser.pm module documentation
|
From: |
Gavin D. Smith |
|
Subject: |
[6053] Parser.pm module documentation |
|
Date: |
Mon, 19 Jan 2015 19:04:26 +0000 |
Revision: 6053
http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6053
Author: gavin
Date: 2015-01-19 19:04:25 +0000 (Mon, 19 Jan 2015)
Log Message:
-----------
Parser.pm module documentation
Modified Paths:
--------------
trunk/ChangeLog
trunk/tp/Texinfo/Parser.pm
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2015-01-19 17:46:50 UTC (rev 6052)
+++ trunk/ChangeLog 2015-01-19 19:04:25 UTC (rev 6053)
@@ -1,3 +1,10 @@
+2015-01-19 Gavin Smith <address@hidden>
+
+ * tp/Texinfo/Parser.pm (Module documentation section): Tweak
+ descriptions of what 'node_manuals' entries and
+ 'menu_entry_node' are. Add section mentioning 'nodes' and
+ 'menus' arrays.
+
2015-01-18 Karl Berry <address@hidden>
* info/t/Init-inter.inc: if mknod doesn't exist,
Modified: trunk/tp/Texinfo/Parser.pm
===================================================================
--- trunk/tp/Texinfo/Parser.pm 2015-01-19 17:46:50 UTC (rev 6052)
+++ trunk/tp/Texinfo/Parser.pm 2015-01-19 19:04:25 UTC (rev 6053)
@@ -1,6 +1,6 @@
# Parser.pm: parse texinfo code into a tree.
#
-# Copyright 2010, 2011, 2012 Free Software Foundation, Inc.
+# Copyright 2010, 2011, 2012, 2013, 2014, 2015 Free Software Foundation, Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@@ -7000,9 +7000,9 @@
=item C<@node>
The arguments are in the I<nodes_manuals> array. Each
-of the entry has a I<node_content> key for
-an array holding the corresponding content, a I<manual_content>
-if there is an associated external manual name, and I<normalized>
+of the entries is a hash with a I<node_content> key for
+an array holding the corresponding content, a I<manual_content> key
+if there is an associated external manual name, and a I<normalized>
key for the normalized label, built as specified in the Texinfo manual
in the B<HTML Xref> node.
@@ -7077,8 +7077,8 @@
=item def_line
The I<def_arg> extra key holds an array reference corresponding to
-the parsed definition line argument. Each of the the element of the
-array is a two element array reference. The first element is the type
+the parsed definition line argument. Each of the elements of the
+array is a two-element array reference. The first element is the type,
which could be I<spaces> for a space, types specific of the
definition, like I<category>, I<name>, I<class>, I<type>, and, at the
end, a mix of I<arg>, I<typearg>, I<delimiter> depending on the definition.
@@ -7175,8 +7175,9 @@
The I<menu_entry_description> and I<menu_entry_name> keys
are associated with the corresponding tree elements. The
-I<menu_entry_node> holds the parsed node entry, like
-the one appearing in the I<nodes_manuals> array for C<@node>.
+I<menu_entry_node> value is a hash with information about the parsed
+node entry; its keys are the same as those appearing in the
+elements of the I<nodes_manuals> array for C<@node>.
=item empty_line_after_command
@@ -7200,6 +7201,19 @@
=back
+=head2 Other information set by the parser
+
+The parser creates an array of nodes and stores this in the
+I<nodes> key of the parser object.
+
+Each element in the tree corresponding to a node contaning a menu
+has a I<menus> key which refers to an array of references to menu
+elements occuring in the node.
+
+These are both used by the C<Texinfo::Structuring> module.
+
+
+
=head1 SEE ALSO
L<Texinfo manual|http://www.gnu.org/s/texinfo/manual/texinfo/>
@@ -7223,7 +7237,7 @@
=head1 COPYRIGHT AND LICENSE
-Copyright 2010, 2011, 2012 Free Software Foundation, Inc.
+Copyright 2010, 2011, 2012, 2013, 2014, 2015 Free Software Foundation, Inc.
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
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [6053] Parser.pm module documentation,
Gavin D. Smith <=