From: Arthur Axel 'fREW' Schmidt <frioux@gmail.com>
Date: Wed, 5 May 2010 05:16:50 +0000 (-0500)
Subject: document various delegation roles by linking to original classes
X-Git-Tag: v0.001000_06~5
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=feca70da2cc034f1209e6990b25f15f4b723930d;p=dbsrgits%2FDBIx-Class-DeploymentHandler.git

document various delegation roles by linking to original classes
---

diff --git a/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedSqltDeployMethod.pm b/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedSqltDeployMethod.pm
index 55157b2..edc18ab 100644
--- a/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedSqltDeployMethod.pm
+++ b/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedSqltDeployMethod.pm
@@ -48,3 +48,8 @@ sub _build_deploy_method {
 
 __END__
 
+=head1 DELEGATION ROLE
+
+This role is entirely for making delegation look like a role.  The actual
+docs for the methods and attributes are at
+L<DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator::Deprecated>
diff --git a/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedVersionStorage.pm b/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedVersionStorage.pm
index 001a74a..7f350d4 100644
--- a/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedVersionStorage.pm
+++ b/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedVersionStorage.pm
@@ -22,3 +22,9 @@ sub _build_version_storage {
 # vim: ts=2 sw=2 expandtab
 
 __END__
+
+=head1 DELEGATION ROLE
+
+This role is entirely for making delegation look like a role.  The actual
+docs for the methods and attributes are at
+L<DBIx::Class::DeploymentHandler::VersionStorage::Deprecated>
diff --git a/lib/DBIx/Class/DeploymentHandler/WithDatabaseToSchemaVersions.pm b/lib/DBIx/Class/DeploymentHandler/WithDatabaseToSchemaVersions.pm
index a1daf09..2b33d6a 100644
--- a/lib/DBIx/Class/DeploymentHandler/WithDatabaseToSchemaVersions.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithDatabaseToSchemaVersions.pm
@@ -32,4 +32,8 @@ sub _build_version_handler {
 
 __END__
 
-TODO: pod
+=head1 DELEGATION ROLE
+
+This role is entirely for making delegation look like a role.  The actual
+docs for the methods and attributes are at
+L<DBIx::Class::DeploymentHandler::VersionHandler::DatabaseToSchemaVersions>
diff --git a/lib/DBIx/Class/DeploymentHandler/WithExplicitVersions.pm b/lib/DBIx/Class/DeploymentHandler/WithExplicitVersions.pm
index 076f6f0..4861960 100644
--- a/lib/DBIx/Class/DeploymentHandler/WithExplicitVersions.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithExplicitVersions.pm
@@ -32,3 +32,8 @@ sub _build_version_handler {
 
 __END__
 
+=head1 DELEGATION ROLE
+
+This role is entirely for making delegation look like a role.  The actual
+docs for the methods and attributes are at
+L<DBIx::Class::DeploymentHandler::VersionHandler::ExplicitVersions>
diff --git a/lib/DBIx/Class/DeploymentHandler/WithMonotonicVersions.pm b/lib/DBIx/Class/DeploymentHandler/WithMonotonicVersions.pm
index a38d43a..f94988e 100644
--- a/lib/DBIx/Class/DeploymentHandler/WithMonotonicVersions.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithMonotonicVersions.pm
@@ -29,3 +29,9 @@ sub _build_version_handler {
 # vim: ts=2 sw=2 expandtab
 
 __END__
+
+=head1 DELEGATION ROLE
+
+This role is entirely for making delegation look like a role.  The actual
+docs for the methods and attributes are at
+L<DBIx::Class::DeploymentHandler::VersionHandler::Monotonic>
diff --git a/lib/DBIx/Class/DeploymentHandler/WithReasonableDefaults.pm b/lib/DBIx/Class/DeploymentHandler/WithReasonableDefaults.pm
index 1ccae70..2f1c913 100644
--- a/lib/DBIx/Class/DeploymentHandler/WithReasonableDefaults.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithReasonableDefaults.pm
@@ -42,3 +42,32 @@ around install_resultsource => sub {
 __END__
 
 vim: ts=2 sw=2 expandtab
+
+=head1 CONVENIENCE
+
+The whole point of this role is to set defaults for arguments of various
+methods.  It's a little awesome.
+
+=head1 METHODS
+
+=head2 prepare_upgrade
+
+Defaulted args:
+
+  my $from_version = $self->database_version;
+  my $to_version   = $self->schema_version;
+  my $version_set  = [$from_version, $to_version];
+
+=head2 prepare_downgrade
+
+Defaulted args:
+
+  my $from_version = $self->database_version;
+  my $to_version   = $self->schema_version;
+  my $version_set  = [$from_version, $to_version];
+
+=head2 install_resultsource
+
+Defaulted args:
+
+  my $version = $self->to_version;
diff --git a/lib/DBIx/Class/DeploymentHandler/WithSqltDeployMethod.pm b/lib/DBIx/Class/DeploymentHandler/WithSqltDeployMethod.pm
index 80fbf77..9ff8417 100644
--- a/lib/DBIx/Class/DeploymentHandler/WithSqltDeployMethod.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithSqltDeployMethod.pm
@@ -51,4 +51,8 @@ sub _build_deploy_method {
 
 __END__
 
-TODO: pod
+=head1 DELEGATION ROLE
+
+This role is entirely for making delegation look like a role.  The actual
+docs for the methods and attributes are at
+L<DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator>
diff --git a/lib/DBIx/Class/DeploymentHandler/WithStandardVersionStorage.pm b/lib/DBIx/Class/DeploymentHandler/WithStandardVersionStorage.pm
index a986ac6..499dde9 100644
--- a/lib/DBIx/Class/DeploymentHandler/WithStandardVersionStorage.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithStandardVersionStorage.pm
@@ -22,3 +22,9 @@ sub _build_version_storage {
 # vim: ts=2 sw=2 expandtab
 
 __END__
+
+=head1 DELEGATION ROLE
+
+This role is entirely for making delegation look like a role.  The actual
+docs for the methods and attributes are at
+L<DBIx::Class::DeploymentHandler::VersionStorage::Standard>