Added documentation and fixed typos.

twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/ImageReaderBase.java

@@ -48,13 +48,14 @@ import java.util.Arrays;
 import java.util.Iterator;
 
 /**
- * ImageReaderBase
+ * Abstract base class for image readers.
  *
  * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
  * @author last modified by $Author: haraldk$
  * @version $Id: ImageReaderBase.java,v 1.0 Sep 20, 2007 5:28:37 PM haraldk Exp$
  */
 public abstract class ImageReaderBase extends ImageReader {
+
     /**
      * For convenience. Only set if the input is an {@code ImageInputStream}.
      * @see #setInput(Object, boolean, boolean)
@@ -129,21 +130,21 @@ public abstract class ImageReaderBase extends ImageReader {
     protected abstract void resetMembers();
 
     /**
-     * Defaul implementation that always return {@code null}.
+     * Default implementation that always returns {@code null}.
      *
-     * @param pImageIndex ignored, unless overriden
-     * @return {@code null}, unless overriden
-     * @throws IOException never, unless overriden.
+     * @param pImageIndex ignored, unless overridden
+     * @return {@code null}, unless overridden
+     * @throws IOException never, unless overridden.
      */
     public IIOMetadata getImageMetadata(int pImageIndex) throws IOException {
         return null;
     }
 
     /**
-     * Defaul implementation that always return {@code null}.
+     * Default implementation that always returns {@code null}.
      *
-     * @return {@code null}, unless overriden
-     * @throws IOException never, unless overriden.
+     * @return {@code null}, unless overridden
+     * @throws IOException never, unless overridden.
      */
     public IIOMetadata getStreamMetadata() throws IOException {
         return null;
@@ -152,9 +153,9 @@ public abstract class ImageReaderBase extends ImageReader {
     /**
      * Default implementation that always returns {@code 1}.
      *
-     * @param pAllowSearch ignored, unless overriden
-     * @return {@code 1}, unless overriden
-     * @throws IOException never, unless overriden
+     * @param pAllowSearch ignored, unless overridden
+     * @return {@code 1}, unless overridden
+     * @throws IOException never, unless overridden
      */
     public int getNumImages(boolean pAllowSearch) throws IOException {
         assertInput();

twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/ImageWriterBase.java

@@ -31,6 +31,7 @@ package com.twelvemonkeys.imageio;
 import com.twelvemonkeys.imageio.util.IIOUtil;
 
 import javax.imageio.ImageWriteParam;
+import javax.imageio.ImageWriter;
 import javax.imageio.metadata.IIOMetadata;
 import javax.imageio.spi.ImageWriterSpi;
 import javax.imageio.stream.ImageOutputStream;
@@ -39,13 +40,13 @@ import java.awt.image.BufferedImage;
 import java.io.IOException;
 
 /**
- * ImageWriterBase
+ * Abstract base class for image writers.
  *
  * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
  * @author last modified by $Author: haraldk$
  * @version $Id: ImageWriterBase.java,v 1.0 Sep 24, 2007 12:22:28 AM haraldk Exp$
  */
-public abstract class ImageWriterBase extends javax.imageio.ImageWriter {
+public abstract class ImageWriterBase extends ImageWriter {
     protected ImageOutputStream mImageOutput;
 
     /**
@@ -95,7 +96,7 @@ public abstract class ImageWriterBase extends javax.imageio.ImageWriter {
      * @param pParam igonred.
      * @return {@code null}.
      */
-    public IIOMetadata getDefaultStreamMetadata(javax.imageio.ImageWriteParam pParam) {
+    public IIOMetadata getDefaultStreamMetadata(ImageWriteParam pParam) {
         return null;
     }
 
@@ -116,7 +117,7 @@ public abstract class ImageWriterBase extends javax.imageio.ImageWriter {
 
     /**
      * Utility method for getting the area of interest (AOI) of an image.
-     * The AOI is defined by the {@link IIOParam#setSourceRegion(java.awt.Rectangle)}
+     * The AOI is defined by the {@link javax.imageio.IIOParam#setSourceRegion(java.awt.Rectangle)}
      * method.
      * <p/>
      * Note: If it is possible for the reader to read the AOI directly, such a
@@ -136,7 +137,7 @@ public abstract class ImageWriterBase extends javax.imageio.ImageWriter {
     /**
      * Utility method for getting the subsampled image.
      * The subsampling is defined by the
-     * {@link IIOParam#setSourceSubsampling(int, int, int, int)}
+     * {@link javax.imageio.IIOParam#setSourceSubsampling(int, int, int, int)}
      * method.
      * <p/>
      * NOTE: This method does not take the subsampling offsets into

twelvemonkeys-imageio/core/src/main/java/com/twelvemonkeys/imageio/spi/ProviderInfo.java

@@ -13,6 +13,9 @@ import com.twelvemonkeys.lang.Validate;
  * @see <a href="http://java.sun.com/j2se/1.5.0/docs/guide/jar/jar.html#JAR%20Manifest">JAR Manifest</a>
  */
 public class ProviderInfo {
+    // TODO: Consider reading the META-INF/MANIFEST.MF from the class path using java.util.jar.Manifest.
+    // Use the manifest that is located in the same class path folder as the package.
+
     private final String mVendorName;
     private final String mVersion;