Moar documentation, shape up license/copyright notices
Peter Rabbitson [Wed, 9 May 2012 06:20:25 +0000 (08:20 +0200)]
lib/SQL/Translator/Generator/DDL/SQLServer.pm
lib/SQL/Translator/Generator/DDL/SQLite.pm
lib/SQL/Translator/Generator/Role/DDL.pm
lib/SQL/Translator/Generator/Role/Quote.pm
lib/SQL/Translator/Producer/SQLServer.pm

index 40e29ea..4b3383e 100644 (file)
@@ -1,7 +1,15 @@
 package SQL::Translator::Generator::DDL::SQLServer;
 
-# AUTHOR: Arthur Axel fREW Schmidt
-# Copyright: Same as Perl 5
+=head1 NAME
+
+SQL::Translator::Generator::DDL::SQLServer - A Moo based MS SQL Server DDL
+generation engine.
+
+=head1 DESCRIPTION
+
+I<documentation volunteers needed>
+
+=cut
 
 use Moo;
 use SQL::Translator::Schema::Constants;
@@ -233,3 +241,18 @@ sub schema {
 
 1;
 
+=head1 AUTHORS
+
+See the included AUTHORS file:
+L<http://search.cpan.org/dist/SQL-Translator/AUTHORS>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the SQL::Translator L</AUTHORS> as listed above.
+
+=head1 LICENSE
+
+This code is free software and may be distributed under the same terms as Perl
+itself.
+
+=cut
index b7649ba..0f55fd9 100644 (file)
@@ -1,8 +1,15 @@
 package SQL::Translator::Generator::DDL::SQLite;
 
-# AUTHOR: Arthur Axel fREW Schmidt
-# Copyright: Same as Perl 5
+=head1 NAME
 
+SQL::Translator::Generator::DDL::SQLite - A Moo based SQLite DDL generation
+engine.
+
+=head1 DESCRIPTION
+
+I<documentation volunteers needed>
+
+=cut
 use Moo;
 
 has quote_chars => (is=>'ro', default=>sub { +[qw(" ")] } );
@@ -89,3 +96,18 @@ sub field {
 
 1;
 
+=head1 AUTHORS
+
+See the included AUTHORS file:
+L<http://search.cpan.org/dist/SQL-Translator/AUTHORS>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the SQL::Translator L</AUTHORS> as listed above.
+
+=head1 LICENSE
+
+This code is free software and may be distributed under the same terms as Perl
+itself.
+
+=cut
index 1691467..e7666c7 100644 (file)
@@ -1,7 +1,15 @@
 package SQL::Translator::Generator::Role::DDL;
 
-# AUTHOR: Arthur Axel fREW Schmidt
-# Copyright: Same as Perl 5
+=head1 NAME
+
+SQL::Translator::Generator::Role::DDL - Role implementing common parts of
+DDL generation.
+
+=head1 DESCRIPTION
+
+I<documentation volunteers needed>
+
+=cut
 
 use Moo::Role;
 use SQL::Translator::Utils qw(header_comment);
@@ -109,3 +117,19 @@ sub nullable { 'NULL' }
 sub header_comments { header_comment() . "\n" if $_[0]->add_comments }
 
 1;
+
+=head1 AUTHORS
+
+See the included AUTHORS file:
+L<http://search.cpan.org/dist/SQL-Translator/AUTHORS>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the SQL::Translator L</AUTHORS> as listed above.
+
+=head1 LICENSE
+
+This code is free software and may be distributed under the same terms as Perl
+itself.
+
+=cut
index 9ca0551..56a02f2 100644 (file)
@@ -1,11 +1,18 @@
-package # hide from pause
-  SQL::Translator::Generator::Role::Quote;
-
-# AUTHOR: Arthur Axel fREW Schmidt
-# Copyright: Same as Perl 5
+package SQL::Translator::Generator::Role::Quote;
 
 use Moo::Role;
 
+=head1 NAME
+
+SQL::Translator::Generator::Role::Quote - Role for dealing with identifier
+quoting.
+
+=head1 DESCRIPTION
+
+I<documentation volunteers needed>
+
+=cut
+
 requires qw(quote_chars name_sep);
 
 sub quote {
@@ -32,3 +39,19 @@ sub quote {
 }
 
 1;
+
+=head1 AUTHORS
+
+See the included AUTHORS file:
+L<http://search.cpan.org/dist/SQL-Translator/AUTHORS>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the SQL::Translator L</AUTHORS> as listed above.
+
+=head1 LICENSE
+
+This code is free software and may be distributed under the same terms as Perl
+itself.
+
+=cut
index cbab3c0..c1181ca 100644 (file)
@@ -20,13 +20,6 @@ sub produce {
 
 1;
 
-=pod
-
-=head1 SQLServer Create Table Syntax
-
-TODO
-
-
 =head1 NAME
 
 SQL::Translator::Producer::SQLServer - MS SQLServer producer for SQL::Translator
@@ -40,8 +33,8 @@ SQL::Translator::Producer::SQLServer - MS SQLServer producer for SQL::Translator
 
 =head1 DESCRIPTION
 
-B<WARNING>B This is still fairly early code, basically a hacked version of the
-Sybase Producer (thanks Sam, Paul and Ken for doing the real work ;-)
+This is currently a thin wrapper around the nextgen
+L<SQL::Translator::Generator::DDL::SQLServer> DDL maker.
 
 =head1 Extra Attributes
 
@@ -86,11 +79,20 @@ List of values for an enum field.
 
 =head1 SEE ALSO
 
-SQL::Translator.
+L<SQL::Translator>
 
 =head1 AUTHORS
 
-Mark Addison E<lt>grommit@users.sourceforge.netE<gt> - Bulk of code from
-Sybase producer, I just tweaked it for SQLServer. Thanks.
+See the included AUTHORS file:
+L<http://search.cpan.org/dist/SQL-Translator/AUTHORS>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the SQL::Translator L</AUTHORS> as listed above.
+
+=head1 LICENSE
+
+This code is free software and may be distributed under the same terms as Perl
+itself.
 
 =cut