[libcode-tidyall-perl] 86/374: document process_source

[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 12a5828b6e0bdfdf3843e9e19a072dde19bea7f8
Author: Jonathan Swartz <swartz at pobox.com>
Date:   Fri Jul 6 16:58:42 2012 -0700

    document process_source
---
 lib/Code/TidyAll.pm |   11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/lib/Code/TidyAll.pm b/lib/Code/TidyAll.pm
index fe08283..42ce841 100644
--- a/lib/Code/TidyAll.pm
+++ b/lib/Code/TidyAll.pm
@@ -499,12 +499,12 @@ Process all files; this implements the C<tidyall -a> option.
 
 =item process_files (file, ...)
 
-Calls L</process_file> on each file. Return a list of
+Call L</process_file> on each file. Return a list of
 L<Code::TidyAll::Result|Code::TidyAll::Result> objects, one for each file.
 
 =item process_file (file)
 
-Process the file, meaning
+Process the I<file>, meaning
 
 =over
 
@@ -530,6 +530,13 @@ Return a L<Code::TidyAll::Result|Code::TidyAll::Result> object
 
 =back
 
+=item process_source (source, path)
+
+Same as L</process_file>, but process the I<source> string instead of a file.
+You must still pass the relative I<path> from the root as the second argument,
+so that we know which plugins to apply. Return a
+L<Code::TidyAll::Result|Code::TidyAll::Result> object.
+
 =item find_conf_file (start_dir)
 
 Start in the I<start_dir> and work upwards, looking for a C<tidyall.ini>.

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