[libcode-tidyall-perl] 67/374: docs

[Jonas Smedegaard]

This is an automated email from the git hooks/post-receive script.

js pushed a commit to branch master
in repository libcode-tidyall-perl.

commit 05f65f5192d913dfb239d46062c13be25c1397d6
Author: Jonathan Swartz <swartz at pobox.com>
Date:   Tue Jul 3 12:16:35 2012 -0700

    docs
---
 lib/Test/Code/TidyAll.pm |   42 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)

diff --git a/lib/Test/Code/TidyAll.pm b/lib/Test/Code/TidyAll.pm
index b6e06bc..212b457 100644
--- a/lib/Test/Code/TidyAll.pm
+++ b/lib/Test/Code/TidyAll.pm
@@ -13,7 +13,7 @@ our @EXPORT    = @EXPORT_OK;
 
 sub tidyall_ok {
     my $conf_file = Code::TidyAll->find_conf_file(".");
-    my $ct        = Code::TidyAll->new( check_only => 1, conf_file => $conf_file );
+    my $ct        = Code::TidyAll->new( check_only => 1, conf_file => $conf_file, @_ );
     my @files     = sort keys( %{ $ct->matched_files } );
     $test->plan( tests => scalar(@files) );
     foreach my $file (@files) {
@@ -30,3 +30,43 @@ sub tidyall_ok {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+Test::Code::TidyAll - check that all your files are tidy and valid according to
+tidyall
+
+=head1 SYNOPSIS
+
+  In a file like 't/tidyall.t':
+
+    #!/usr/bin/perl
+    use Test::TidyAll;
+    tidyall_ok();
+
+=head1 DESCRIPTION
+
+Uses L<tidyall --check-only|tidyall> to check that all the files in your
+project are in a tidied and valid state, i.e. that no plugins throw errors or
+would change the contents of the file. Does not actually modify any files.
+
+By default, looks for config file C<tidyall.ini> in the current directory and
+parent directories, which is generally the right place if you are running
+L<prove|prove>.
+
+C<tidyall_ok> is exported by default. Any options will be passed along to the
+L<Code::TidyAll|Code::TidyAll> constructor. For example, if you don't want to
+use the tidyall cache and instead check all files every time:
+
+    run_tests(no_cache => 1);
+
+or if you need to specify the config file:
+
+    run_tests(conf_file => '/path/to/conf/file');
+
+=head1 SEE ALSO
+
+L<tidyall|tidyall>
+

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libcode-tidyall-perl.git