From: Ken Youens-Clark <kclark@cpan.org>
Date: Fri, 22 Aug 2003 22:51:51 +0000 (+0000)
Subject: Fixing docs.
X-Git-Tag: v0.04~228
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=56435d6f4ec93dffd737ae13077ba72ad297e3f5;p=dbsrgits%2FSQL-Translator.git

Fixing docs.
---

diff --git a/lib/SQL/Translator/Parser.pm b/lib/SQL/Translator/Parser.pm
index 5dc23a0..8f56b0a 100644
--- a/lib/SQL/Translator/Parser.pm
+++ b/lib/SQL/Translator/Parser.pm
@@ -1,7 +1,7 @@
 package SQL::Translator::Parser;
 
 # ----------------------------------------------------------------------
-# $Id: Parser.pm,v 1.7 2003-08-22 22:48:20 kycl4rk Exp $
+# $Id: Parser.pm,v 1.8 2003-08-22 22:51:51 kycl4rk Exp $
 # ----------------------------------------------------------------------
 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
 #                    darren chamberlain <darren@cpan.org>,
@@ -24,7 +24,7 @@ package SQL::Translator::Parser;
 
 use strict;
 use vars qw( $VERSION );
-$VERSION = sprintf "%d.%02d", q$Revision: 1.7 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
 
 sub parse { "" }
 
@@ -69,6 +69,6 @@ darren chamberlain E<lt>darren@cpan.orgE<gt>.
 
 =head1 SEE ALSO
 
-perl(1), SQL::Translator::Schema.
+perl(1), SQL::Translator, SQL::Translator::Schema.
 
 =cut
diff --git a/lib/SQL/Translator/Producer.pm b/lib/SQL/Translator/Producer.pm
index dff7fea..d10ca07 100644
--- a/lib/SQL/Translator/Producer.pm
+++ b/lib/SQL/Translator/Producer.pm
@@ -1,7 +1,7 @@
 package SQL::Translator::Producer;
 
 # -------------------------------------------------------------------
-# $Id: Producer.pm,v 1.5 2003-01-27 17:04:45 dlc Exp $
+# $Id: Producer.pm,v 1.6 2003-08-22 22:51:51 kycl4rk Exp $
 # -------------------------------------------------------------------
 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
 #                    darren chamberlain <darren@cpan.org>,
@@ -24,7 +24,7 @@ package SQL::Translator::Producer;
 
 use strict;
 use vars qw($VERSION);
-$VERSION = sprintf "%d.%02d", q$Revision: 1.5 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.6 $ =~ /(\d+)\.(\d+)/;
 
 sub produce { "" }
 
@@ -39,24 +39,23 @@ sub produce { "" }
 
 =head1 NAME
 
-SQL::Translator::Producer - base object for Producers
-
-=head1 SYNOPSIS
+SQL::Translator::Producer - describes how to write a producer
 
 =head1 DESCRIPTION
 
 Producer modules designed to be used with SQL::Translator need to
 implement a single function, called B<produce>.  B<produce> will be
-called with a data structure created by a SQL::Translator::Parser
-subclass.  It is expected to return a string containing a valid SQL
-create statement.
+called with the SQL::Translator object from which it is expected to 
+retrieve the SQL::Translator::Schema object which has been populated 
+by the parser.  It is expected to return a string.
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 
 =head1 SEE ALSO
 
-perl(1).
+perl(1), SQL::Translator, SQL::Translator::Schema.
 
 =cut
diff --git a/lib/SQL/Translator/Producer/XML.pm b/lib/SQL/Translator/Producer/XML.pm
index 3cc8bdb..ef09eee 100644
--- a/lib/SQL/Translator/Producer/XML.pm
+++ b/lib/SQL/Translator/Producer/XML.pm
@@ -1,7 +1,7 @@
 package SQL::Translator::Producer::XML;
 
 # -------------------------------------------------------------------
-# $Id: XML.pm,v 1.14 2003-08-21 01:06:52 kycl4rk Exp $
+# $Id: XML.pm,v 1.15 2003-08-22 22:51:51 kycl4rk Exp $
 # -------------------------------------------------------------------
 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>.
 #
@@ -26,21 +26,27 @@ package SQL::Translator::Producer::XML;
 
 SQL::Translator::Producer::XML - Alias to XML::SQLFairy producer
 
-=head1 SYNOPSIS
+=head1 DESCRIPTION
 
 Previous versions of SQL::Translator included an XML producer, but the 
 namespace has since been further subdivided.  Therefore, this module is 
 now just just an alias to the XML::SQLFairy producer.
 
+=head1 SEE ALSO
+
+SQL::Translator::Producer::XML::SQLFairy.
+
 =head1 AUTHOR
 
 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 
 =cut
 
+# -------------------------------------------------------------------
+
 use strict;
 use vars qw[ $VERSION $DEBUG ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.14 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.15 $ =~ /(\d+)\.(\d+)/;
 $DEBUG = 1 unless defined $DEBUG;
 
 use SQL::Translator::Producer::XML::SQLFairy;