]> git.imager.perl.org - imager.git/commitdiff
- removed unused hashinfo() function from Imager.xs
authorTony Cook <tony@develop=help.com>
Wed, 1 Mar 2006 02:15:22 +0000 (02:15 +0000)
committerTony Cook <tony@develop=help.com>
Wed, 1 Mar 2006 02:15:22 +0000 (02:15 +0000)
- added =items for various methods, so Pod::Coverage will pick them up
  (Pod::Coverage tests to be added in 0.49)

Changes
Imager.pm
Imager.xs
lib/Imager/Engines.pod
lib/Imager/Files.pod
lib/Imager/Filters.pod
lib/Imager/ImageTypes.pod
lib/Imager/Transformations.pod

diff --git a/Changes b/Changes
index 7e55eef7e26123214b9f6e2a1774ab76cbc3bbcf..93b546d97cb874aee0763b3cca7ed101ed891d7c 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1366,6 +1366,11 @@ Revision history for Perl extension Imager.
   custom META.yml was a waste.
 - bump to 0.47_01
 
   custom META.yml was a waste.
 - bump to 0.47_01
 
+0.48
+- removed unused hashinfo() function from Imager.xs
+- added =items for various methods, so Pod::Coverage will pick them up
+  (Pod::Coverage tests to be added in 0.49)
+
 =================================================================
 
         For latest versions check the Imager-devel pages:
 =================================================================
 
         For latest versions check the Imager-devel pages:
index b36bb32b281b19729298efd62d5eb4bb533d02f1..af8ffd4dfd2c14956502d2f6e2d56f3a9473582b 100644 (file)
--- a/Imager.pm
+++ b/Imager.pm
@@ -3389,7 +3389,7 @@ channel values
 
 masked() -  L<Imager::ImageTypes/masked> - make a masked image
 
 
 masked() -  L<Imager::ImageTypes/masked> - make a masked image
 
-matrix_transform() - L<Imager::Engines/"Matrix Transformations">
+matrix_transform() - L<Imager::Engines/matrix_transform>
 
 maxcolors() - L<Imager::ImageTypes/maxcolors>
 
 
 maxcolors() - L<Imager::ImageTypes/maxcolors>
 
@@ -3415,8 +3415,6 @@ image and use the alpha channel
 
 scale() - L<Imager::Transformations/scale>
 
 
 scale() - L<Imager::Transformations/scale>
 
-setscanline() - L<Imager::Draw/setscanline>
-
 scaleX() - L<Imager::Transformations/scaleX>
 
 scaleY() - L<Imager::Transformations/scaleY>
 scaleX() - L<Imager::Transformations/scaleX>
 
 scaleY() - L<Imager::Transformations/scaleY>
@@ -3426,6 +3424,10 @@ a paletted image
 
 setpixel() - L<Imager::Draw/setpixel>
 
 
 setpixel() - L<Imager::Draw/setpixel>
 
+setscanline() - L<Imager::Draw/setscanline>
+
+settag() - L<Imager::ImageTypes/settag>
+
 set_file_limits() - L<Imager::Files/"Limiting the sizes of images you read">
 
 string() - L<Imager::Draw/string> - draw text on an image
 set_file_limits() - L<Imager::Files/"Limiting the sizes of images you read">
 
 string() - L<Imager::Draw/string> - draw text on an image
index 6c9dafe6352d3e27e45874361ccc60042e3bcc9b..015510e3e50c2c3a601aabfa8f2d972e56e11d45 100644 (file)
--- a/Imager.xs
+++ b/Imager.xs
@@ -3255,18 +3255,6 @@ i_nearest_color(im, ...)
 void
 malloc_state()
 
 void
 malloc_state()
 
-void
-hashinfo(hv)
-            PREINIT:
-              HV* hv;
-              int stuff;
-            PPCODE:
-              if (!SvROK(ST(0))) croak("Imager: Parameter 0 must be a reference to a hash\n");        
-              hv=(HV*)SvRV(ST(0));
-              if (SvTYPE(hv)!=SVt_PVHV) croak("Imager: Parameter 0 must be a reference to a hash\n");
-              if (getint(hv,"stuff",&stuff)) printf("ok: %d\n",stuff); else printf("key doesn't exist\n");
-              if (getint(hv,"stuff2",&stuff)) printf("ok: %d\n",stuff); else printf("key doesn't exist\n");
-              
 void
 DSO_open(filename)
              char*       filename
 void
 DSO_open(filename)
              char*       filename
index 6437f83191977a871638ae37f7ed85077720dc4d..af021d3aefabe8b8d6c19427e0d6e60a8059cd07 100644 (file)
@@ -328,6 +328,10 @@ L<Imager::regmach.pod>.
 
 =head2 Matrix Transformations
 
 
 =head2 Matrix Transformations
 
+=over
+
+=item matrix_transform
+
 Rather than having to write code in a little language, you can use a
 matrix to perform affine transformations, using the matrix_transform()
 method:
 Rather than having to write code in a little language, you can use a
 matrix to perform affine transformations, using the matrix_transform()
 method:
@@ -356,4 +360,6 @@ transparent pixels in the middle of the source image, it is B<only>
 used for pixels where there is no corresponding pixel in the source
 image.
 
 used for pixels where there is no corresponding pixel in the source
 image.
 
+=back
+
 =cut
 =cut
index 33706d0b57dcdfb1f9719d661b648dd5896c70b8..2f1fc97035f4149875512499ff6fc2962f9c840f 100644 (file)
@@ -183,6 +183,10 @@ Return either a valid Imager file type, or undef.
 
 =head2 Limiting the sizes of images you read
 
 
 =head2 Limiting the sizes of images you read
 
+=over
+
+=item set_file_limits
+
 In some cases you will be receiving images from an untested source,
 such as submissions via CGI.  To prevent such images from consuming
 large amounts of memory, you can set limits on the dimensions of
 In some cases you will be receiving images from an untested source,
 such as submissions via CGI.  To prevent such images from consuming
 large amounts of memory, you can set limits on the dimensions of
@@ -233,11 +237,14 @@ pass:
   # only bytes is limited
   Imager->set_file_limits(reset=>1, bytes=>10_000_000);
 
   # only bytes is limited
   Imager->set_file_limits(reset=>1, bytes=>10_000_000);
 
+=item get_file_limits
+
 You can get the current limits with the get_file_limits() method:
 
   my ($max_width, $max_height, $max_bytes) =
      Imager->get_file_limits();
 
 You can get the current limits with the get_file_limits() method:
 
   my ($max_width, $max_height, $max_bytes) =
      Imager->get_file_limits();
 
+=back
 
 =head1 TYPE SPECIFIC INFORMATION
 
 
 =head1 TYPE SPECIFIC INFORMATION
 
index b5beed76887de9bff3d74208bfdbabb17b9c4051..58ea995e5f4e84d03abbf622b18d26b4c0d6c392 100644 (file)
@@ -28,6 +28,26 @@ Imager::Filters - Entire Image Filtering Operations
 
 Filters are operations that have similar calling interface.
 
 
 Filters are operations that have similar calling interface.
 
+=over
+
+=item filter
+
+Parameters:
+
+=over
+
+=item *
+
+type - the type of filter, see L</Types of Filters>.
+
+=item *
+
+many other possible parameters, see L</Types of Filters> below.
+
+=back
+
+=back
+
 =head2 Types of Filters
 
 Here is a list of the filters that are always avaliable in Imager.
 =head2 Types of Filters
 
 Here is a list of the filters that are always avaliable in Imager.
@@ -568,8 +588,37 @@ Note: This seems to test ok on the following systems:
 Linux, Solaris, HPUX, OpenBSD, FreeBSD, TRU64/OSF1, AIX.
 If you test this on other systems please let me know.
 
 Linux, Solaris, HPUX, OpenBSD, FreeBSD, TRU64/OSF1, AIX.
 If you test this on other systems please let me know.
 
+=over
+
+=item load_plugin
+
+This is a function, not a method, exported by default.  You should
+import this function explicitly for future compatibility if you need
+it.
+
+Accepts a single parameter, the name of a shared library file to load.
+
+Returns true on success.  Check Imager->errstr on failure.
+
+=item unload_plugin
+
+This is a function, not a method, which is exported by default.  You
+should import this function explicitly for future compatibility if you
+need it.
+
+Accepts a single parameter, the name of a shared library to unload.
+This library must have been previously loaded by load_plugin().
+
+Returns true on success.  Check Imager->errstr on failure.
+
+=back
+
 =head2 Image Difference
 
 =head2 Image Difference
 
+=over
+
+=item difference
+
 You can create a new image that is the difference between 2 other images.
 
   my $diff = $img->difference(other=>$other_img);
 You can create a new image that is the difference between 2 other images.
 
   my $diff = $img->difference(other=>$other_img);
@@ -585,4 +634,6 @@ Note that $img and $other_img must have the same number of channels.
 The width and heigh of $diff will be the minimum of each of the width
 and height of $img and $other_img.
 
 The width and heigh of $diff will be the minimum of each of the width
 and height of $img and $other_img.
 
+=back
+
 =cut
 =cut
index bfc7cd470c8723065eafa5df18c14dc52185dc3a..62b925ef7b77cd7fe931143875c3ee8362c8e5d7 100644 (file)
@@ -623,6 +623,11 @@ or by code:
 
 In each case deltag() returns the number of tags deleted.
 
 
 In each case deltag() returns the number of tags deleted.
 
+=item settag
+
+settag() replaces any existing tags with a new tag.  This is
+equivalent to calling deltag() then addtag().
+
 =back
 
 =head2 Common Tags
 =back
 
 =head2 Common Tags
index 664bfdf2652accb87ef3265d4b37935692752a7e..392698d5bf678013cd23d9a6d51019a35e717e4c 100644 (file)
@@ -558,6 +558,10 @@ reason for failure.
 
 =head2 Color transformations
 
 
 =head2 Color transformations
 
+=over
+
+=item convert
+
 You can use the convert method to transform the color space of an
 image using a matrix.  For ease of use some presets are provided.
 
 You can use the convert method to transform the color space of an
 image using a matrix.  For ease of use some presets are provided.
 
@@ -689,8 +693,14 @@ alpha channel:
                                            [ 0, 0, 0, 0.5 ],
                                          ]);
 
                                            [ 0, 0, 0, 0.5 ],
                                          ]);
 
+=back
+
 =head2 Color Mappings
 
 =head2 Color Mappings
 
+=over
+
+=item map
+
 You can use the map method to map the values of each channel of an
 image independently using a list of lookup tables.  It's important to
 realize that the modification is made inplace.  The function simply
 You can use the map method to map the values of each channel of an
 image independently using a list of lookup tables.  It's important to
 realize that the modification is made inplace.  The function simply
@@ -731,6 +741,8 @@ maps to the C<red> and C<blue> channels one would use:
 
   $img->map(maps=>[\@redmap, [], \@bluemap]);
 
 
   $img->map(maps=>[\@redmap, [], \@bluemap]);
 
+=back
+
 =head1 SEE ALSO
 
 L<Imager>, L<Imager::Engines>
 =head1 SEE ALSO
 
 L<Imager>, L<Imager::Engines>