From: Marcus Ramberg <mramberg@cpan.org>
Date: Fri, 29 Jul 2005 14:32:04 +0000 (+0000)
Subject: basic pod stubs for everything but the CDBI compat layer.
X-Git-Tag: v0.03001~122
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class.git;a=commitdiff_plain;h=34d52be2d55c86c6eddd2317157db7f2accbe810

basic pod stubs for everything but the CDBI compat layer.
---

diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm
index a67d2b7..d473c2d 100644
--- a/lib/DBIx/Class.pm
+++ b/lib/DBIx/Class.pm
@@ -10,3 +10,27 @@ use vars qw($VERSION);
 $VERSION = '0.01';
 
 1;
+
+=head1 NAME 
+
+DBIx::Class - Because the brain is a terrible thing to waste.
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This is a sql to oop mapper, inspired by the L<Class::DBI> framework, 
+and meant to support compability with it, while restructuring the 
+insides, and making it possible to support some new features like 
+self-joins, distinct, group bys and more.
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+
diff --git a/lib/DBIx/Class/AccessorGroup.pm b/lib/DBIx/Class/AccessorGroup.pm
index a7e85be..f85c714 100644
--- a/lib/DBIx/Class/AccessorGroup.pm
+++ b/lib/DBIx/Class/AccessorGroup.pm
@@ -5,6 +5,23 @@ use warnings;
 
 use NEXT;
 
+=head1 NAME 
+
+DBIx::Class::AccessorGroup -  Lets you build groups of accessors
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This class lets you build groups of accessors that will call different
+getters and setters.
+
+=head1 METHODS
+
+=over 4
+
+=cut
+
 sub mk_group_accessors {
     my($self, $group, @fields) = @_;
 
@@ -120,3 +137,16 @@ sub make_group_wo_accessor {
 }
 
 1;
+
+=back
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+
diff --git a/lib/DBIx/Class/CDBICompat.pm b/lib/DBIx/Class/CDBICompat.pm
index 066f0c8..1a2103b 100644
--- a/lib/DBIx/Class/CDBICompat.pm
+++ b/lib/DBIx/Class/CDBICompat.pm
@@ -22,3 +22,24 @@ use base qw/DBIx::Class::CDBICompat::Convenience
             DBIx::Class::CDBICompat::ImaDBI/;
 
 1;
+
+=head1 NAME 
+
+DBIx::Class::CDBICompat - Class::DBI Compatability layer.
+
+=head1 DESCRIPTION
+
+This class just inherits from the various modules that makes 
+up the Class::DBI compability layer.
+
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+
diff --git a/lib/DBIx/Class/Core.pm b/lib/DBIx/Class/Core.pm
index 7b005a0..4a3cf36 100644
--- a/lib/DBIx/Class/Core.pm
+++ b/lib/DBIx/Class/Core.pm
@@ -13,3 +13,24 @@ use base qw/DBIx::Class::Relationship
             DBIx::Class::AccessorGroup/;
 
 1;
+
+=head1 NAME 
+
+DBIx::Class::Core - Core set of DBIx::Class modules.
+
+=head1 DESCRIPTION
+
+This class just inherits from the various modules that makes 
+up the Class::DBI  core features.
+
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+
diff --git a/lib/DBIx/Class/DB.pm b/lib/DBIx/Class/DB.pm
index 1df8835..a54ba0d 100644
--- a/lib/DBIx/Class/DB.pm
+++ b/lib/DBIx/Class/DB.pm
@@ -7,6 +7,22 @@ __PACKAGE__->mk_classdata('_dbi_connect_info');
 __PACKAGE__->mk_classdata('_dbi_connect_package');
 __PACKAGE__->mk_classdata('_dbh');
 
+=head1 NAME 
+
+DBIx::Class::DB - DBIx::Class Database connection
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This class represents the connection to the database
+
+=head1 METHODS
+
+=over 4
+
+=cut
+
 sub _get_dbh {
   my ($class) = @_;
   my $dbh;
@@ -35,3 +51,16 @@ sub connection {
 }
 
 1;
+
+=back
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+
diff --git a/lib/DBIx/Class/PK.pm b/lib/DBIx/Class/PK.pm
index fc03c57..32165dc 100644
--- a/lib/DBIx/Class/PK.pm
+++ b/lib/DBIx/Class/PK.pm
@@ -7,6 +7,24 @@ use base qw/Class::Data::Inheritable DBIx::Class::SQL/;
 
 __PACKAGE__->mk_classdata('_primaries' => {});
 
+=head1 NAME 
+
+DBIx::Class::PK - Primary Key class
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This class represents methods handling primary keys
+and depending on them.
+
+=head1 METHODS
+
+=over 4
+
+=cut
+
+
 sub _ident_cond {
   my ($class) = @_;
   return join(" AND ", map { "$_ = ?" } keys %{$class->_primaries});
@@ -69,3 +87,16 @@ sub id {
 }
 
 1;
+
+=back
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+
diff --git a/lib/DBIx/Class/PK/Auto.pm b/lib/DBIx/Class/PK/Auto.pm
index 98e3b89..2436120 100644
--- a/lib/DBIx/Class/PK/Auto.pm
+++ b/lib/DBIx/Class/PK/Auto.pm
@@ -3,6 +3,28 @@ package DBIx::Class::PK::Auto;
 use strict;
 use warnings;
 
+=head1 NAME 
+
+DBIx::Class::PK::Auto - Automatic Primary Key class
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This class overrides the insert method to get automatically
+incremented primary keys.
+
+=head1 METHODS
+
+=over 4
+
+=item insert
+
+Overrides insert so that it will get the value of autoincremented
+primary keys.
+
+=cut
+
 sub insert {
   my ($self, @rest) = @_;
   my $ret = $self->NEXT::ACTUAL::insert(@rest);
@@ -23,3 +45,16 @@ sub insert {
 }
 
 1;
+
+=back
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+
diff --git a/lib/DBIx/Class/PK/Auto/SQLite.pm b/lib/DBIx/Class/PK/Auto/SQLite.pm
index 98d1c07..9a526a5 100644
--- a/lib/DBIx/Class/PK/Auto/SQLite.pm
+++ b/lib/DBIx/Class/PK/Auto/SQLite.pm
@@ -8,3 +8,24 @@ sub _last_insert_id {
 }
 
 1;
+
+=head1 NAME 
+
+DBIx::Class::PK::Auto::SQLite - Automatic Primary Key class for SQLite
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This class implements autoincrements for SQLite.
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+
diff --git a/lib/DBIx/Class/Relationship.pm b/lib/DBIx/Class/Relationship.pm
index 04bb4b3e..3843251 100644
--- a/lib/DBIx/Class/Relationship.pm
+++ b/lib/DBIx/Class/Relationship.pm
@@ -7,6 +7,24 @@ use base qw/Class::Data::Inheritable/;
 
 __PACKAGE__->mk_classdata('_relationships', { } );
 
+=head1 NAME 
+
+DBIx::Class::Relationship - Inter-table relationships
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This class handles relationships between the tables in your database
+model. It allows your to set up relationships, and to perform joins
+on searches.
+
+=head1 METHODS
+
+=over 4
+
+=cut
+
 sub add_relationship {
   my ($class, $rel, $f_class, $cond, $attrs) = @_;
   my %rels = %{ $class->_relationships };
@@ -102,3 +120,16 @@ sub create_related {
 }
 
 1;
+
+=back
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+
diff --git a/lib/DBIx/Class/SQL.pm b/lib/DBIx/Class/SQL.pm
index 6bba4d9..80d3516 100644
--- a/lib/DBIx/Class/SQL.pm
+++ b/lib/DBIx/Class/SQL.pm
@@ -9,6 +9,20 @@ use constant COLS => 0;
 use constant FROM => 1;
 use constant COND => 2;
 
+=head1 NAME 
+
+DBIx::Class::SQL -  SQL Specific methods for DBIx::Class
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This class contains methods that generates SQL queries for
+the rest of the L<DBIx::Class> hiarchy. It's also responsible
+for executing these.
+
+=cut
+
 __PACKAGE__->mk_classdata('_sql_statements',
   {
     'select' =>
@@ -41,3 +55,13 @@ sub _get_sth {
 }
 
 1;
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
diff --git a/lib/DBIx/Class/SQL/Abstract.pm b/lib/DBIx/Class/SQL/Abstract.pm
index 93a477c..44b3efa 100644
--- a/lib/DBIx/Class/SQL/Abstract.pm
+++ b/lib/DBIx/Class/SQL/Abstract.pm
@@ -140,3 +140,26 @@ sub _cond_value {
 }
   
 1;
+
+=head1 NAME 
+
+DBIx::Class::SQL::Abstract - SQL::Abstract customized for DBIC.
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This is a customized version of L<SQL::Abstract> for use in 
+generating L<DBIx::Searchbuilder> searches.
+
+=cut
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
diff --git a/lib/DBIx/Class/SQL/OrderBy.pm b/lib/DBIx/Class/SQL/OrderBy.pm
index e64123b..12d9129 100644
--- a/lib/DBIx/Class/SQL/OrderBy.pm
+++ b/lib/DBIx/Class/SQL/OrderBy.pm
@@ -17,3 +17,26 @@ sub _cond_resolve {
 }
 
 1;
+
+=head1 NAME 
+
+DBIx::Class::SQL::OrderBy - Implements sorting for DBIC's SQL backend
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This class implements the order_by attribute to L<DBIx::Class>'s search
+builder.
+
+=cut
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
diff --git a/lib/DBIx/Class/Table.pm b/lib/DBIx/Class/Table.pm
index 29cc816..aacbe0b 100644
--- a/lib/DBIx/Class/Table.pm
+++ b/lib/DBIx/Class/Table.pm
@@ -9,7 +9,24 @@ __PACKAGE__->mk_classdata('_columns' => {});
 
 __PACKAGE__->mk_classdata('_table_name');
 
-__PACKAGE__->mk_classdata('table_alias'); # Doesn't actually do anything yet!
+__PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet!
+
+=head1 NAME 
+
+DBIx::Class::Table - Basic table methods
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This class is responsible for defining and doing basic operations on 
+L<DBIx::Class> objects.
+
+=head1 METHODS
+
+=over 4
+
+=cut
 
 sub new {
   my ($class, $attrs) = @_;
@@ -212,3 +229,16 @@ sub table {
 }
 
 1;
+
+=back
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+