[Rt-commit] r13785 - in rt/3.8/trunk: .

[spang at bestpractical.com]

Author: spang
Date: Thu Jul  3 15:37:00 2008
New Revision: 13785

Modified:
   rt/3.8/trunk/   (props changed)
   rt/3.8/trunk/lib/RT/Test.pm

Log:
 r43585 at loki:  spang | 2008-07-03 17:19:48 +0100
 move comments to pod


Modified: rt/3.8/trunk/lib/RT/Test.pm
==============================================================================
--- rt/3.8/trunk/lib/RT/Test.pm	(original)
+++ rt/3.8/trunk/lib/RT/Test.pm	Thu Jul  3 15:37:00 2008
@@ -603,16 +603,31 @@
     return undef;
 }
 
+=head2 get_relocateable_dir
+
+Takes a path relative to the location of the test file that is being
+run and returns a path that takes the invocation path into account.
+
+e.g. RT::Test::get_relocateable_dir(File::Spec->updir(), 'data', 'emails')
+
+=cut
+
 sub get_relocateable_dir {
-    # takes a path relative to the location of the test file and returns
-    # a path that takes the invocation path into account
     (my $volume, my $directories, my $file) = File::Spec->splitpath($0);
     return File::Spec->catdir(File::Spec->curdir(), $directories, @_);
 }
 
+=head2 get_relocateable_file
+
+Same as get_relocateable_dir, but takes a file and a path instead
+of just a path.
+
+e.g. RT::Test::get_relocateable_file('test-email',
+        (File::Spec->updir(), 'data', 'emails'))
+
+=cut
+
 sub get_relocateable_file {
-    # same as get_relocateable_dir, but takes a file and a path instead
-    # of just a path
     my $file = shift;
     return File::Spec->catfile(get_relocateable_dir(@_), $file);
 }