]> git.imager.perl.org - imager.git/commitdiff
Minor pod changes.
authorArnar Mar Hrafnkelsson <addi@cpan.org>
Thu, 7 Mar 2002 18:11:12 +0000 (18:11 +0000)
committerArnar Mar Hrafnkelsson <addi@cpan.org>
Thu, 7 Mar 2002 18:11:12 +0000 (18:11 +0000)
Changes
Imager.pm
lib/Imager/Draw.pod
lib/Imager/ImageTypes.pod
lib/Imager/Transformations.pod

diff --git a/Changes b/Changes
index 3311fbac7fe802483661fe4325021dfea67a2dfc..c560816ecb87b133558f443e55196cc2e402fafa 100644 (file)
--- a/Changes
+++ b/Changes
@@ -604,7 +604,7 @@ Revision history for Perl extension Imager.
         - we now log which memory block is being freed before giving 
           an error on it being re-freed
         - fixed stupid bug in deleting tags
-
+       - fixed minor pod errors involving &gt;
 
 =================================================================
 
index 0a4c9a28a0e44af7c62faa1e4744a4f9f8bfad2c..fb3d026f8bb19d30b71313734fa9749f6665e8bc 100644 (file)
--- a/Imager.pm
+++ b/Imager.pm
@@ -2727,15 +2727,13 @@ Helper for making gradient profiles.
 
 =head2 Basic Overview
 
-An Image object is created with C<$img = Imager-E<gt>new()> Should
-this fail for some reason an explanation can be found in
-C<$Imager::ERRSTR> usually error messages are stored in
-C<$img-E<gt>{ERRSTR}>, but since no object is created this is the only
-way to give back errors.  C<$Imager::ERRSTR> is also used to report
-all errors not directly associated with an image object. Examples:
+An Image object is created with C<$img = Imager-E<gt>new()>.
+Examples:
 
-  $img=Imager->new(); # This is an empty image (size is 0 by 0)
-  $img->open(file=>'lena.png',type=>'png'); # initializes from file
+  $img=Imager->new();                         # create empty image
+  $img->open(file=>'lena.png',type=>'png') or # read image from file
+     die $img->errstr();                      # give an explanation
+                                              # if something failed
 
 or if you want to create an empty image:
 
@@ -2744,6 +2742,14 @@ or if you want to create an empty image:
 This example creates a completely black image of width 400 and height
 300 and 4 channels.
 
+When an operation fails which can be directly associated with an image
+the error message is stored can be retrieved with
+C<$img-E<gt>errstr()>.
+
+In cases where no image object is associated with an operation
+C<$Imager::ERRSTR> is used to report errors not directly associated
+with an image object.
+
 =head1 SUPPORT
 
 You can ask for help, report bugs or express your undying love for
@@ -2756,6 +2762,7 @@ To subscribe send a message with C<subscribe> in the body to:
 or use the form at:
 
    http://www.molar.is/en/lists/imager-devel/
+   (annonymous is temporarily off due to spam)
 
 where you can also find the mailing list archive.
 
@@ -2769,14 +2776,21 @@ Bugs are listed individually for relevant pod pages.
 
 =head1 AUTHOR
 
-Arnar M. Hrafnkelsson (addi@umich.edu) and Tony Cook
+Arnar M. Hrafnkelsson (addi@imager.perl.org) and Tony Cook
 (tony@imager.perl.org) See the README for a complete list.
 
 =head1 SEE ALSO
 
-perl(1), Imager::Color(3), Imager::Font(3), Imager::Matrix2d(3),
+perl(1), Imager::ImageTypes(3), Imager::Files(3), Imager::Draw(3),
+Imager::Color(3), Imager::Fill(3), Imager::Font(3),
+Imager::Transformations(3), Imager::Engines(3), Imager::Filters(3),
+Imager::Expr(3), Imager::Matrix2d(3), Imager::Fountain(3)
 
 Affix::Infix2Postfix(3), Parse::RecDescent(3)
 http://www.eecs.umich.edu/~addi/perl/Imager/
 
 =cut
+
+
+
+
index ec0d8d5cc8ef3d6e83696dfb8c1df8764646519c..40e58648f8049525c8a14c89df7677d532d8301a 100644 (file)
@@ -113,7 +113,7 @@ pattern:
             fill => { hatch=>'cross2' });
 
 Also if a color is omitted a color with (255,255,255,255) is used
-instead.  [NOTE: This may change to use C<$img-&gt;fgcolor()> in the future].
+instead.  [NOTE: This may change to use C<$img-E<gt>fgcolor()> in the future].
 
 Box does not support fractional coordinates yet.
 
index 8e679e6c06cdf965d5c552117dcfdc39ef91eb81..2d0f5cf844d3a474fc2730a0a8b73ff0f8b9575d 100644 (file)
@@ -159,7 +159,7 @@ If you have an existing image, use img_set() to change it's dimensions
 The C<getwidth()> method returns the width of the image.  This value
 comes either from C<new()> with xsize,ysize parameters or from reading
 data from a file with C<read()>.  If called on an image that has no
-valid data in it like C<Imager-&gt;new()> returns, the return value of
+valid data in it like C<Imager-E<gt>new()> returns, the return value of
 C<getwidth()> is undef.
 
 =item getheight
index b3f98f5fabbef1abeba9019d93259ecd0ceb3ce6..21cdd8d79d946e4f91a51a539dd2731d30d40cc1 100644 (file)
@@ -291,7 +291,7 @@ For each output pixel the following matrix multiplication is done:
   |    ...     | = |       ...        | x |     ...      |
   | channel[k] |   | $ck0, ...,  $ckk |   | inchannel[k] |
                                                           1
-Where C<k = $img-&gt;getchannels()-1>.
+Where C<k = $img-E<gt>getchannels()-1>.
 
 So if you want to swap the red and green channels on a 3 channel image: