From: Arthur Axel 'fREW' Schmidt <frioux@gmail.com>
Date: Tue, 18 May 2010 05:03:41 +0000 (-0500)
Subject: undocument private methods
X-Git-Tag: v0.001000_10~2
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class-DeploymentHandler.git;a=commitdiff_plain;h=db223affb80dc5b32c23ebb756b7d172afb2f796

undocument private methods
---

diff --git a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm
index c45dafd..982a62a 100644
--- a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm
+++ b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm
@@ -622,7 +622,9 @@ transaction.
 The version the schema on your harddrive is at.  Defaults to
 C<< $self->schema->schema_version >>.
 
-=method __ddl_consume_with_prefix
+=begin comment
+
+=head2 __ddl_consume_with_prefix
 
  $dm->__ddl_consume_with_prefix( 'SQLite', [qw( 1.00 1.01 )], 'up' )
 
@@ -630,48 +632,48 @@ This is the meat of the multi-file upgrade/deploy stuff.  It returns a list of
 files in the order that they should be run for a generic "type" of upgrade.
 You should not be calling this in user code.
 
-=method _ddl_schema_consume_filenames
+=head2 _ddl_schema_consume_filenames
 
  $dm->__ddl_schema_consume_filenames( 'SQLite', [qw( 1.00 )] )
 
 Just a curried L</__ddl_consume_with_prefix>.  Get's a list of files for an
 initial deploy.
 
-=method _ddl_schema_produce_filename
+=head2 _ddl_schema_produce_filename
 
  $dm->__ddl_schema_produce_filename( 'SQLite', [qw( 1.00 )] )
 
 Returns a single file in which an initial schema will be stored.
 
-=method _ddl_schema_up_consume_filenames
+=head2 _ddl_schema_up_consume_filenames
 
  $dm->_ddl_schema_up_consume_filenames( 'SQLite', [qw( 1.00 )] )
 
 Just a curried L</__ddl_consume_with_prefix>.  Get's a list of files for an
 upgrade.
 
-=method _ddl_schema_down_consume_filenames
+=head2 _ddl_schema_down_consume_filenames
 
  $dm->_ddl_schema_down_consume_filenames( 'SQLite', [qw( 1.00 )] )
 
 Just a curried L</__ddl_consume_with_prefix>.  Get's a list of files for a
 downgrade.
 
-=method _ddl_schema_up_produce_filenames
+=head2 _ddl_schema_up_produce_filenames
 
  $dm->_ddl_schema_up_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
 
 Returns a single file in which the sql to upgrade from one schema to another
 will be stored.
 
-=method _ddl_schema_down_produce_filename
+=head2 _ddl_schema_down_produce_filename
 
  $dm->_ddl_schema_down_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
 
 Returns a single file in which the sql to downgrade from one schema to another
 will be stored.
 
-=method _resultsource_install_filename
+=head2 _resultsource_install_filename
 
  my $filename_fn = $dm->_resultsource_install_filename('User');
  $dm->$filename_fn('SQLite', '1.00')
@@ -679,7 +681,7 @@ will be stored.
 Returns a function which in turn returns a single filename used to install a
 single resultsource.  Weird interface is convenient for me.  Deal with it.
 
-=method _run_sql_and_perl
+=head2 _run_sql_and_perl
 
  $dm->_run_sql_and_perl([qw( list of filenames )])
 
@@ -689,7 +691,7 @@ C<.sql> it runs it as sql and if it ends in C<.pl> it runs it as a perl file.
 Depending on L</txn_wrap> all of the files run will be wrapped in a single
 transaction.
 
-=method _prepare_install
+=head2 _prepare_install
 
  $dm->_prepare_install({ add_drop_table => 0 }, sub { 'file_to_create' })
 
@@ -697,7 +699,7 @@ Generates the sql file for installing the database.  First arg is simply
 L<SQL::Translator> args and the second is a coderef that returns the filename
 to store the sql in.
 
-=method _prepare_changegrade
+=head2 _prepare_changegrade
 
  $dm->_prepare_changegrade('1.00', '1.01', [qw( 1.00 1.01)], 'up')
 
@@ -706,10 +708,11 @@ arg is the version to start from, second is the version to go to, third is the
 L<version set|DBIx::Class::DeploymentHandler/VERSION SET>, and last is the
 direction of the changegrade, be it 'up' or 'down'.
 
-=method _read_sql_file
+=head2 _read_sql_file
 
  $dm->_read_sql_file('foo.sql')
 
 Reads a sql file and returns lines in an C<ArrayRef>.  Strips out comments,
 transactions, and blank lines.
 
+=end comment