cvs commit: cocoon-2.1/src/java/org/apache/cocoon/reading ImageReader.java

[crossley]

crossley    2004/03/20 19:49:48

  Modified:    src/java/org/apache/cocoon/reading ImageReader.java
  Log:
  Add javadoc comments about the "allow-enlarging" parameter.
  
  Revision  Changes    Path
  1.9       +10 -2     
cocoon-2.1/src/java/org/apache/cocoon/reading/ImageReader.java
  
  Index: ImageReader.java
  ===================================================================
  RCS file: 
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/reading/ImageReader.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- ImageReader.java  11 Mar 2004 18:46:31 -0000      1.8
  +++ ImageReader.java  21 Mar 2004 03:49:48 -0000      1.9
  @@ -66,7 +66,15 @@
    *     </dd>
    *     <dt>&lt;grayscale&gt;</dt>
    *     <dd>This parameter is optional. When specified and set to true it
  - *         will cause each image pixel to be normalized. 
  + *         will cause each image pixel to be normalized. Default is "false".
  + *     </dd>
  + *     <dt>&lt;allow-enlarging&gt;</dt>
  + *     <dd>This parameter is optional. By default, if the image is smaller
  + *         than the specified width and height, the image will be enlarged.
  + *         In some circumstances this behaviour is undesirable, and can be
  + *         switched off by setting this parameter to "no" so that images will
  + *         be reduced in size, but not enlarged. The default is "yes".
  +
    *     </dd>
    *   </dl>
    *