App::Dthumb::Data documentation improvements

1 files changed, 73 insertions, 65 deletions

diff --git a/lib/App/Dthumb/Data.pm.PL b/lib/App/Dthumb/Data.pm.PL
index 13b244b..168397a 100644
--- a/lib/App/Dthumb/Data.pm.PL
+++ b/lib/App/Dthumb/Data.pm.PL
@@ -38,33 +38,6 @@ close($out_fh);
 __DATA__
 package App::Dthumb::Data;
 
-
-=head1 NAME
-
-App::Dthumb::Data - Retrieve installed data (like lightbox images)
-
-=head1 SYNOPSIS
-
-    use App::Dthumb::Data;
-    my $data = App::Dthumb::Data->new();
-    
-    $data->set_vars(
-    	title => 'Something funky',
-    );
-    
-    print $data->get('html_start.dthumb');
-    
-    open(my $fh, '>', 'close.png');
-    print {$fh} $data->get('close.png');
-    close($fh);
-
-=head1 VERSION
-
-This manual documents B<App::Dthumb::Data> version 0.2
-
-=cut
-
-
 use strict;
 use warnings;
 
@@ -73,32 +46,12 @@ use MIME::Base64 qw(decode_base64);
 
 our $VERSION = '0.2';
 
-
-=head1 METHODS
-
-=head2 new
-
-Returns a new B<App::Dthumb> object. Does not take any arguments.
-
-=cut
-
-
 sub new {
 	my ($obj) = @_;
 	my $ref = {};
 	return bless($ref, $obj);
 }
 
-
-=head2 set_vars(%vars)
-
-Set replacement variables.  For each hash key, when outputting data using the
-B<get> function, dthumb will replace occurences of "<!-- $key -->" or "/* $key
-*/" (the dollar sign is literal) with its value.
-
-=cut
-
-
 sub set_vars {
 	my ($self, %vars) = @_;
 
@@ -107,29 +60,11 @@ sub set_vars {
 	}
 }
 
-
-=head2 list_archived
-
-Returns an array of all saved data.  That is, all files which do not end in
-".dthumb".
-
-=cut
-
-
 sub list_archived {
 	my ($self) = @_;
 	return grep { ! /\.dthumb$/ } $self->section_data_names();
 }
 
-
-=head2 get($filename)
-
-Returns the exact content of share/$filename (undef if no such file was
-saved).
-
-=cut
-
-
 sub get {
 	my ($self, $name) = @_;
 	my $data = $self->section_data($name);
@@ -159,6 +94,70 @@ sub get {
 
 1;
 
+=head1 NAME
+
+App::Dthumb::Data - Retrieve installed data (like lightbox images)
+
+=head1 SYNOPSIS
+
+    use App::Dthumb::Data;
+    my $data = App::Dthumb::Data->new();
+    
+    $data->set_vars(
+    	title => 'Something funky',
+    );
+    
+    print $data->get('html_start.dthumb');
+    
+    open(my $fh, '>', 'close.png');
+    print {$fh} $data->get('close.png');
+    close($fh);
+
+=head1 VERSION
+
+This manual documents B<App::Dthumb::Data> version 0.2
+
+=head1 DESCRIPTION
+
+Since there seems to be no nice way of installing additional data with
+Module::Build, this modules uses Data::Section to save all B<dthumb> data
+(images, javascript, stylesheets...) in its __DATA__.  It provides methods to
+retrieve this data and optionally replace certain variables in it with other
+content.
+
+While building B<App::Dthumb>, this module reads all files in the F<share>
+directory and saves them in its __DATA__ section.
+
+=head1 METHODS
+
+=over
+
+=item $data = App::Dthumb::Data->new()
+
+Returns a new B<App::Dthumb::Data> object. Does not take any arguments.
+
+=item $data->set_vars(I<%vars>)
+
+Set replacement variables.  For each hash key, when outputting data using the
+B<get> function, dthumb will replace occurences of "<!-- $key -->" or "/* $key
+*/" (the dollar sign is literal) with its value.
+
+=item $data->list_archived()
+
+Returns an array of all saved data.  That is, all files which do not end in
+".dthumb".
+
+=item $data->get($filename)
+
+Returns the exact content of share/$filename (undef if no such file was
+saved).
+
+=back
+
+=head1 DIAGNOSTICS
+
+None.
+
 =head1 DEPENDENCIES
 
 =over
@@ -167,6 +166,15 @@ sub get {
 
 =back
 
+=head1 BUGS AND LIMITATIONS
+
+So far, none are known.  This module has proved to work fine with both binary
+and ASCII files.
+
+However, since it encodes binary files with base64, you shouldn't use it with
+too many / too large files, otherwise you'll end up with a rather big module
+file.
+
 =head1 AUTHOR
 
 Copyright (C) 2011 by Daniel Friesel E<lt>derf@chaosdorf.deE<gt>