texinfo/tp/Texinfo/Convert Texinfo.pm

[Patrice Dumas]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Patrice Dumas <pertusus>        11/10/01 08:21:34

Modified files:
        tp/Texinfo/Convert: Texinfo.pm 

Log message:
        Document Texinfo::Convert::Texinfo.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/tp/Texinfo/Convert/Texinfo.pm?cvsroot=texinfo&r1=1.6&r2=1.7

Patches:
Index: Texinfo.pm
===================================================================
RCS file: /sources/texinfo/texinfo/tp/Texinfo/Convert/Texinfo.pm,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- Texinfo.pm  29 Sep 2011 08:40:18 -0000      1.6
+++ Texinfo.pm  1 Oct 2011 08:21:34 -0000       1.7
@@ -30,7 +30,21 @@
 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
 @ISA = qw(Exporter);
 
address@hidden = ('convert');
+# Items to export into callers namespace by default. Note: do not export
+# names by default without a very good reason. Use EXPORT_OK instead.
+# Do not simply export all your public functions/methods/constants.
+
+# This allows declaration   use Texinfo::Convert::Texinfo ':all';
+# If you do not need this, moving things directly into @EXPORT or @EXPORT_OK
+# will save memory.
+%EXPORT_TAGS = ( 'all' => [ qw(
+  convert
+) ] );
+
address@hidden = ( @{ $EXPORT_TAGS{'all'} } );
+
address@hidden = qw(
+);
 
 $VERSION = '0.01';
 
@@ -77,7 +91,7 @@
     if ($root->{'cmdname'} and (defined($block_commands{$root->{'cmdname'}}))
         and !($root->{'extra'} and $root->{'extra'}->{'end_command'})) {
       $result .= '@end '.$root->{'cmdname'};
-      #Â a missing @end
+      # a missing @end
       $result .= "\n" if ($block_commands{$root->{'cmdname'}} ne 'raw');
     }
   }
@@ -155,54 +169,47 @@
 
 1;
 __END__
-# Below is stub documentation.
 
 =head1 NAME
 
-Texinfo::Parser - Perl extension for blah blah blah
+Texinfo::Convert::Texinfo - Convert a Texinfo tree to Texinfo code
 
 =head1 SYNOPSIS
 
-  use Texinfo::Parser;
-  blah blah blah
-
-=head1 DESCRIPTION
-
-Stub documentation for Texinfo::Parser, created by h2xs. It looks like the
-author of the extension was negligent enough to leave the stub
-unedited.
+  use Texinfo::Convert::Texinfo qw(convert);
 
-Blah blah blah.
+  my $texinfo_text = convert($tree);
 
-=head2 EXPORT
-
-None by default.
+=head1 DESCRIPTION
 
+Texinfo::Convert::Texinfo converts a Texinfo tree (described in 
+L<Texinfo::Parser>) to Texinfo code.  If the Texinfo tree results from 
+parsing some Texinfo document, The converted Texinfo code should be
+exactly the same as the initial document, except that user defined @-macros 
+and C<@value> are expanded, and some invalid code is discarded.
 
+=head1 METHODS
 
-=head1 SEE ALSO
+=over
 
-Mention other useful documentation such as the documentation of
-related modules or operating system documentation (such as man pages
-in UNIX), or any relevant external documentation such as RFCs or
-standards.
+=item $texinfo_text = convert($tree)
 
-If you have a mailing list set up for your module, mention it here.
+Converts the Texinfo tree I<$tree> to Texinfo code.
 
-If you have a web site set up for your module, mention it here.
+=back
 
 =head1 AUTHOR
 
-Patrice Dumas, E<lt>address@hidden<gt>
+Patrice Dumas, E<lt>address@hidden<gt>
 
 =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
-# the Free Software Foundation; either version 3 of the License,
-# or (at your option) any later version.
-
+the Free Software Foundation; either version 3 of the License, or (at 
+your option) any later version.
 
 =cut
+