texinfo/tp/Texinfo Common.pm Parser.pm Structur...

[Patrice Dumas]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Patrice Dumas <pertusus>        11/09/28 06:53:38

Modified files:
        tp/Texinfo     : Common.pm Parser.pm Structuring.pm 

Log message:
        finish Texinfo::Common documentation.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/tp/Texinfo/Common.pm?cvsroot=texinfo&r1=1.62&r2=1.63
http://cvs.savannah.gnu.org/viewcvs/texinfo/tp/Texinfo/Parser.pm?cvsroot=texinfo&r1=1.304&r2=1.305
http://cvs.savannah.gnu.org/viewcvs/texinfo/tp/Texinfo/Structuring.pm?cvsroot=texinfo&r1=1.87&r2=1.88

Patches:
Index: Common.pm
===================================================================
RCS file: /sources/texinfo/texinfo/tp/Texinfo/Common.pm,v
retrieving revision 1.62
retrieving revision 1.63
diff -u -b -r1.62 -r1.63
--- Common.pm   27 Sep 2011 23:44:09 -0000      1.62
+++ Common.pm   28 Sep 2011 06:53:38 -0000      1.63
@@ -1240,9 +1240,8 @@
 
 =item %context_brace_commands
 
address@hidden with brace enclosing texinfo fragment that are outside
-of the main text in one way or another, namely C<@footnote>,
-C<@caption> and C<@math>.
address@hidden with brace like C<@footnote>, C<@caption> and C<@math>
+whose argument is outside of the main text flow in one way or another.
 
 =item %ref_commands
 
@@ -1311,13 +1310,65 @@
 
 No method is exported in the default case.
 
+Most methods takes a I<$converter> as argument, sometime optionally, 
+to get some information and use methods for error reporting, 
+see L<Texinfo::convert::Converter> and L<Texinfo::Report>.
+
 =over
 
-=item expand_today($converter)
+=item $tree = expand_today($converter)
 
 Expand today's date, as a texinfo tree with translations.
 
+=item $tree = expand_verbatiminclude($converter, $verbatiminclude)
+
+The I<$converter> argument may be undef.  I<$verbatiminclude> is a
+C<@verbatiminclude> tree element.  This function returns a 
+C<@verbatim> tree elements after finding the included file and
+reading it.
+
+=item $tree = definition_category($converter, $def_line)
+
+The I<$converter> argument may be undef.  I<$def_line> is a 
+C<def_line> texinfo tree container.  This function
+returns a texinfo tree corresponding to the category of the
+I<$def_line> taking the class into account, if there is one.
+
+=item trim_spaces_comment_from_content($contents)
+
+Remove empty spaces after commands or braces at begina and
+and spaces and comments at end from a content array, modifying it.
+
+=item ($caption, $prepended) = float_name_caption ($converter, $float)
+
+I<$float> is a texinfo tree C<@float> element.  This function 
+returns the caption that should be used for the float formatting 
+and the I<$prepended> texinfo tree combining the type and label
+of the float.
+
+=item $normalized_name = normalize_top_node_name ($node_string)
+
+Normalize the node name string given in argument, by normalizing
+Top node case.
+
 =back
 
+=head1 SEE ALSO
+
+L<Texinfo::Parser>, L<Texinfo::convert::Converter> and L<Texinfo::Report>. 
+
+=head1 AUTHOR
+
+Patrice Dumas, E<lt>address@hidden<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2010, 2011 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
+the Free Software Foundation; either version 3 of the License,
+or (at your option) any later version.
+
 =cut
 

Index: Parser.pm
===================================================================
RCS file: /sources/texinfo/texinfo/tp/Texinfo/Parser.pm,v
retrieving revision 1.304
retrieving revision 1.305
diff -u -b -r1.304 -r1.305
--- Parser.pm   27 Sep 2011 21:16:04 -0000      1.304
+++ Parser.pm   28 Sep 2011 06:53:38 -0000      1.305
@@ -6088,7 +6088,7 @@
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright (C) 2010 Free Software Foundation, Inc.
+Copyright (C) 2010, 2011 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

Index: Structuring.pm
===================================================================
RCS file: /sources/texinfo/texinfo/tp/Texinfo/Structuring.pm,v
retrieving revision 1.87
retrieving revision 1.88
diff -u -b -r1.87 -r1.88
--- Structuring.pm      27 Sep 2011 21:16:04 -0000      1.87
+++ Structuring.pm      28 Sep 2011 06:53:38 -0000      1.88
@@ -1413,6 +1413,9 @@
 
 No method is exported in the default case.
 
+Most of those function references takes a Texinfo::Parser object
+as argument, see L<Texinfo::Parser>.
+
 =over
 
 =item $sections_root = sectioning_structure ($parser, $tree)
@@ -1684,4 +1687,22 @@
 
 =back
 
+=head1 SEE ALSO
+
+L<Texinfo manual|http://www.gnu.org/s/texinfo/manual/texinfo/>, 
+L<Texinfo::Parser>.
+
+=head1 AUTHOR
+
+Patrice Dumas, E<lt>address@hidden<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2010, 2011 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
+the Free Software Foundation; either version 3 of the License,
+or (at your option) any later version.
+
 =cut