Changeset 1649

Timestamp:

09/02/06 06:56:05

Author:

mark

Message:

r14@travis: mark | 2006-09-01 21:13:39 +0100

added even more documentation to the Test

Base extention

trunk/plagger/t/TestPlagger.pm

@@ -289 +289 @@
-use File::Temp ();
-
+
+=over
+
+=item interpolate
+
+Filter that replaces scalar values of the type
+
+  $foo
+  $foo::bar
+
+With their actual values.  But don't do backslash escaped things like
+
+  \$foo
+
+Note that you can't do this either:
+
+  ${foo}
+
+Meaning you can't use $foo like so:
+
+  BAR$fooHELLO
+  
+=cut
+
+ define the interpolate filter - replace $vars with 
-sub interpolate {
-    my $stuff = shift;
-
-
+
+
+
+
+
+
+
+
+
-    $stuff;
-}
+
+=item config
+
+Filter that configures plagger based on the YAML passed in.
+
+=cut
-
-sub config {
-    my $yaml = shift;
+    
+    # replace $foo values with their actual values
-    $yaml = $self->interpolate($yaml);
-
@@ -309 +349 @@
-}
-
+=item output_file
+
+Reads the file who's filename is in $main::output and returns it (failing on problems)
+
+=cut
+
-sub output_file {
-    my $output = $main::output or die "\$main::output is undefined";