summaryrefslogtreecommitdiff
path: root/lib/PDF/Builder/Basic/PDF/String.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/PDF/Builder/Basic/PDF/String.pm')
-rw-r--r--lib/PDF/Builder/Basic/PDF/String.pm58
1 files changed, 44 insertions, 14 deletions
diff --git a/lib/PDF/Builder/Basic/PDF/String.pm b/lib/PDF/Builder/Basic/PDF/String.pm
index 526a85b..3371103 100644
--- a/lib/PDF/Builder/Basic/PDF/String.pm
+++ b/lib/PDF/Builder/Basic/PDF/String.pm
@@ -20,8 +20,8 @@ use base 'PDF::Builder::Basic::PDF::Objind';
use strict;
use warnings;
-our $VERSION = '3.025'; # VERSION
-our $LAST_UPDATE = '3.024'; # manually update whenever code is changed
+our $VERSION = '3.026'; # VERSION
+our $LAST_UPDATE = '3.026'; # manually update whenever code is changed
=head1 NAME
@@ -30,8 +30,6 @@ for simple objects that are basically stringlike (Number, Name, etc.)
=head1 METHODS
-=over
-
=cut
our %trans = (
@@ -56,12 +54,18 @@ our %out_trans = (
')' => ')',
);
-=item PDF::Builder::Basic::PDF::String->from_pdf($string)
+=head2 from_pdf
+
+ PDF::Builder::Basic::PDF::String->from_pdf($string)
+
+=over
Creates a new string object (not a full object yet) from a given
string. The string is parsed according to input criteria with
escaping working.
+=back
+
=cut
sub from_pdf {
@@ -74,12 +78,18 @@ sub from_pdf {
return $self;
}
-=item PDF::Builder::Basic::PDF::String->new($string)
+=head2 new
+
+ PDF::Builder::Basic::PDF::String->new($string)
+
+=over
Creates a new string object (not a full object yet) from a given
string. The string is parsed according to input criteria with
escaping working.
+=back
+
=cut
sub new {
@@ -92,10 +102,16 @@ sub new {
return $self;
}
-=item $s->convert($str)
+=head2 convert
+
+ $s->convert($str)
+
+=over
Returns $str converted as per criteria for input from PDF file
+=back
+
=cut
sub convert {
@@ -171,20 +187,32 @@ sub convert {
return $output;
}
-=item $s->val()
+=head2 val
+
+ $s->val()
+
+=over
Returns the value of this string (the string itself).
+=back
+
=cut
sub val {
return $_[0]->{'val'};
}
-=item $s->as_pdf()
+=head2 as_pdf
+
+ $s->as_pdf()
+
+=over
Returns the string formatted for output as PDF for PDF File object $pdf.
+=back
+
=cut
sub as_pdf {
@@ -210,10 +238,16 @@ sub as_pdf {
}
}
-=item $s->outobjdeep($fh, $pdf)
+=head2 outobjdeep
+
+ $s->outobjdeep($fh, $pdf)
+
+=over
Outputs the string in PDF format, complete with necessary conversions.
+=back
+
=cut
sub outobjdeep {
@@ -223,8 +257,4 @@ sub outobjdeep {
return;
}
-=back
-
-=cut
-
1;