document return values

diff --git a/lib/PXElator/upstream.pm b/lib/PXElator/upstream.pm
index 3c39b0c..c77e7fe 100644 (file)
--- a/lib/PXElator/upstream.pm
+++ b/lib/PXElator/upstream.pm
@@ -22,6 +22,12 @@ sub mirror_file {
                ;
 }
 
+=head2 iso
+
+  my $iso_path = upstream::iso 'http://example.com/bootable.iso';
+
+=cut
+
 sub iso {
        my $url = shift;
 
@@ -50,6 +56,12 @@ sub iso {
        return $iso;
 }
 
+=head2 files
+
+  my $to_dir = upstream::files qw(http://base.url.example.com/ file1 file2 file2);
+
+=cut
+
 sub files {
        my $url = shift;
        my @files = @_;
@@ -70,6 +82,8 @@ sub files {
                mirror_file( "$url/$file", "$path/$file" )
                        if ! -e "$path/$file" || once::first_time( "$url/$file" );
        }
+
+       return $path;
 }
 
 1;