Fixed copyrights.

[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / POD.pm

diff --git a/lib/SQL/Translator/Producer/POD.pm b/lib/SQL/Translator/Producer/POD.pm
index 76b618a..04bd685 100644 (file)
--- a/lib/SQL/Translator/Producer/POD.pm
+++ b/lib/SQL/Translator/Producer/POD.pm
@@ -1,9 +1,9 @@
 package SQL::Translator::Producer::POD;
 
 # -------------------------------------------------------------------
-# $Id: POD.pm,v 1.1 2003-06-09 05:37:04 kycl4rk Exp $
+# $Id: POD.pm,v 1.5 2004-02-09 23:02:15 kycl4rk Exp $
 # -------------------------------------------------------------------
-# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
+# Copyright (C) 2002-4 SQLFairy Authors
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License as
@@ -20,9 +20,29 @@ package SQL::Translator::Producer::POD;
 # 02111-1307  USA
 # -------------------------------------------------------------------
 
+=head1 NAME
+
+SQL::Translator::Producer::POD - POD producer for SQL::Translator
+
+=head1 SYNOPSIS
+
+  use SQL::Translator;
+
+  my $t = SQL::Translator->new( parser => '...', producer => 'POD', '...' );
+  print $t->translate;
+
+=head1 DESCRIPTION
+
+Creates a POD description of each table, field, index, and constraint.  
+A good starting point for text documentation of a schema.  You can 
+easily convert the output to HTML or text using "perldoc" or other 
+interesting formats using Pod::POM or Template::Toolkit's POD plugin.
+
+=cut
+
 use strict;
 use vars qw[ $VERSION ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.1 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.5 $ =~ /(\d+)\.(\d+)/;
 
 use SQL::Translator::Schema::Constants;
 use SQL::Translator::Utils qw(header_comment);
@@ -33,8 +53,9 @@ sub produce {
     my $schema      = $t->schema;
     my $schema_name = $schema->name || 'Schema';
     my $args        = $t->producer_args;
+    my $title       = $args->{'title'} || $schema_name;
 
-    my $pod = "=pod\n\n=head1 DESCRIPTION\n\n$schema_name\n\n=head1 TABLES\n\n";
+    my $pod = "=pod\n\n=head1 DESCRIPTION\n\n$title\n\n=head1 TABLES\n\n";
 
     for my $table ( $schema->get_tables ) {
         my $table_name = $table->name or next;
@@ -44,7 +65,7 @@ sub produce {
         #
         # Fields
         #
-        for my $field ( $table->get_fields ) {
+        for my $field ( @fields ) {
             $pod .= "=head4 " . $field->name . "\n\n=over 4\n\n";
 
             my $data_type = $field->data_type;
@@ -87,10 +108,11 @@ sub produce {
                     join(', ', $c->fields ) . "\n\n";
 
                 if ( $c->type eq FOREIGN_KEY ) {
-                    $pod .= "=item * Reference Table = " . 
-                        $c->reference_table . "\n\n";
+                    $pod .= "=item * Reference Table = L</" . 
+                        $c->reference_table . ">\n\n";
                     $pod .= "=item * Reference Fields = " . 
-                        join(', ', $c->reference_fields ) . "\n\n";
+                        join(', ', map {"L</$_>"} $c->reference_fields ) . 
+                        "\n\n";
                 }
 
                 if ( my $update = $c->on_update ) {
@@ -106,7 +128,10 @@ sub produce {
         }
     }
 
-    $pod .= "=head1 PRODUCED BY\n\n" . header_comment('', ''). "=cut";
+    my $header = ( map { $_ || () } split( /\n/, header_comment('', '') ) )[0];
+       $header =~ s/^Created by //;
+    $pod .= "=head1 PRODUCED BY\n\n$header\n\n=cut";
+
     return $pod;
 }
 
@@ -117,25 +142,14 @@ sub produce {
 # William Blake
 # -------------------------------------------------------------------
 
-=head1 NAME
-
-SQL::Translator::Producer::POD - POD producer for SQL::Translator
-
-=head1 SYNOPSIS
-
-  use SQL::Translator::Producer::POD;
-
-=head1 DESCRIPTION
-
-Creates a POD description of each table, field, index, and constraint.  
-A good starting point for text documentation of a schema.
+=pod
 
 =head1 AUTHOR
 
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 
 =head1 SEE ALSO
 
-perldoc perlpod.
+perldoc, perlpod, Pod::POM, Template::Manual::Plugins.
 
 =cut