From: Ken Youens-Clark <kclark@cpan.org>
Date: Wed, 15 Oct 2003 19:19:13 +0000 (+0000)
Subject: POD fixes.
X-Git-Tag: v0.04~62
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=75c75c55c6f51425c9b3667396d60ce32e0d341a;p=dbsrgits%2FSQL-Translator.git

POD fixes.
---

diff --git a/lib/SQL/Translator/Producer/Sybase.pm b/lib/SQL/Translator/Producer/Sybase.pm
index 96314c8..c7a293b 100644
--- a/lib/SQL/Translator/Producer/Sybase.pm
+++ b/lib/SQL/Translator/Producer/Sybase.pm
@@ -1,12 +1,11 @@
 package SQL::Translator::Producer::Sybase;
 
 # -------------------------------------------------------------------
-# $Id: Sybase.pm,v 1.7 2003-10-04 00:06:39 phrrngtn Exp $
+# $Id: Sybase.pm,v 1.8 2003-10-15 19:16:32 kycl4rk Exp $
 # -------------------------------------------------------------------
 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
-#                    darren chamberlain <darren@cpan.org>,
-#                    Chris Mungall <cjm@fruitfly.org>,
-#                    Sam Angiuoli <angiuoli@users.sourceforge.net>
+#   Paul Harrington <harringp@deshaw.com>,
+#   Sam Angiuoli <angiuoli@users.sourceforge.net>.
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License as
@@ -27,11 +26,22 @@ package SQL::Translator::Producer::Sybase;
 
 SQL::Translator::Producer::Sybase - Sybase producer for SQL::Translator
 
+=head1 SYNOPSIS
+
+  use SQL::Translator;
+
+  my $t = SQL::Translator->new( parser => '...', producer => 'Sybase' );
+  $t->translate;
+
+=head1 DESCRIPTION
+
+This module will produce text output of the schema suitable for Sybase.
+
 =cut
 
 use strict;
 use vars qw[ $DEBUG $WARN $VERSION ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.7 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
 $DEBUG = 1 unless defined $DEBUG;
 
 use Data::Dumper;
@@ -334,11 +344,13 @@ sub produce {
         my (@comments, $procedure_name);
 
         $procedure_name = $procedure->name();
-        push @comments, "--\n-- Procedure: $procedure_name\n--" unless $no_comments;
+        push @comments, 
+            "--\n-- Procedure: $procedure_name\n--" unless $no_comments;
 
-        # text of procedure  already has the 'create procedure' stuff so there
-        # is no need to do anything fancy. However, we should think about doing fancy stuff
-        # with granting permissions and so on.
+        # text of procedure  already has the 'create procedure' stuff
+        # so there is no need to do anything fancy. However, we should
+        # think about doing fancy stuff with granting permissions and
+        # so on.
 
         $output .= join("\n\n",
                        @comments,
@@ -427,9 +439,14 @@ sub unreserve {
 
 =pod
 
+=head1 SEE ALSO
+
+SQL::Translator.
+
 =head1 AUTHORS
 
 Sam Angiuoli E<lt>angiuoli@users.sourceforge.netE<gt>,
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+Paul Harrington E<lt>harringp@deshaw.comE<gt>,
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 
 =cut
diff --git a/lib/SQL/Translator/Producer/YAML.pm b/lib/SQL/Translator/Producer/YAML.pm
index 408f361..0f75531 100644
--- a/lib/SQL/Translator/Producer/YAML.pm
+++ b/lib/SQL/Translator/Producer/YAML.pm
@@ -1,7 +1,7 @@
 package SQL::Translator::Producer::YAML;
 
 # -------------------------------------------------------------------
-# $Id: YAML.pm,v 1.4 2003-10-09 21:51:08 kycl4rk Exp $
+# $Id: YAML.pm,v 1.5 2003-10-15 19:19:13 kycl4rk Exp $
 # -------------------------------------------------------------------
 # Copyright (C) 2003 darren chamberlain <darren@cpan.org>,
 #   Ken Y. Clark <kclark@cpan.org>.
@@ -21,9 +21,29 @@ package SQL::Translator::Producer::YAML;
 # 02111-1307  USA
 # -------------------------------------------------------------------
 
+=head1 NAME
+
+SQL::Translator::Producer::YAML - A YAML producer for SQL::Translator
+
+=head1 SYNOPSIS
+
+  use SQL::Translator;
+
+  my $translator = SQL::Translator->new;
+  $translator->producer('YAML');
+
+=head1 DESCRIPTION
+
+This module uses YAML to serialize a schema to a string so that it
+can be saved to disk.  Serializing a schema and then calling producers
+on the stored can realize significant performance gains when parsing
+takes a long time.
+
+=cut
+
 use strict;
 use vars qw($VERSION);
-$VERSION = sprintf "%d.%02d", q$Revision: 1.4 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.5 $ =~ /(\d+)\.(\d+)/;
 
 use YAML qw(Dump);
 
@@ -127,9 +147,11 @@ sub view_view {
 
 1;
 
-=head1 NAME
+# -------------------------------------------------------------------
 
-SQL::Translator::Producer::YAML - A YAML producer for SQL::Translator
+=head1 SEE ALSO
+
+SQL::Translator, YAML, http://www.yaml.org/.
 
 =head1 AUTHORS