]> git.imager.perl.org - imager.git/commitdiff
document the i_comment common tag
authorTony Cook <tony@develop-help.com>
Mon, 9 Apr 2012 11:02:58 +0000 (21:02 +1000)
committerTony Cook <tony@develop-help.com>
Sat, 14 Apr 2012 04:08:56 +0000 (14:08 +1000)
lib/Imager/ImageTypes.pod

index ad4af8ca74fd41eb39f3c0c5ea06c5ed76e74b14..3e577eaa3c58ac68bd5f63c33e72a71ace78624e 100644 (file)
@@ -886,6 +886,12 @@ specification like "#FF0000" into a color object for you, but if you
 set this as a tag you will need to format it like
 C<color(>I<red>C<,>I<green>C<,>I<blue>C<)>, eg color(255,0,0).
 
+=item *
+
+X<i_comment>C<i_comment> - used when reading or writing several image
+formats.  If the format has only one text field it will be read into
+the C<i_comment> tag or written to the file.
+
 =back
 
 =head2 Quantization options