Javadoc corrections and formatting
diff --git a/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/DecoderFactory.html b/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/DecoderFactory.html
index 3b0d234..138a76a 100644
--- a/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/DecoderFactory.html
+++ b/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/DecoderFactory.html
@@ -108,7 +108,7 @@
<hr>
<br>
<pre>public interface <span class="typeNameLabel">DecoderFactory<T></span></pre>
-<div class="block">Interface for decoder (and region decoder) factories.</div>
+<div class="block">Interface for <a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder"><code>ImageDecoder</code></a> and <a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder"><code>ImageRegionDecoder</code></a> factories.</div>
</li>
</ul>
</div>
diff --git a/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/ImageDecoder.html b/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/ImageDecoder.html
index bb5dc05..afd253a 100644
--- a/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/ImageDecoder.html
+++ b/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/ImageDecoder.html
@@ -104,7 +104,7 @@
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ImageDecoder</span></pre>
-<div class="block">Interface for image decoding classes, allowing the default <code>BitmapRegionDecoder</code>
+<div class="block">Interface for image decoding classes, allowing the default <code>BitmapFactory</code>
based on the Skia library to be replaced with a custom class.</div>
</li>
</ul>
@@ -155,19 +155,21 @@
<pre>android.graphics.Bitmap decode(android.content.Context context,
android.net.Uri uri)
throws java.lang.Exception</pre>
-<div class="block">Decode an image. When possible, initial setup work once in this method. This method
- must return the dimensions of the image. The URI can be in one of the following formats:
- File: file:///scard/picture.jpg
- Asset: file:///android_asset/picture.png
- Resource: android.resource://com.example.app/drawable/picture</div>
+<div class="block">Decode an image. The URI can be in one of the following formats:
+ <br>
+ File: <code>file:///scard/picture.jpg</code>
+ <br>
+ Asset: <code>file:///android_asset/picture.png</code>
+ <br>
+ Resource: <code>android.resource://com.example.app/drawable/picture</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>context</code> - Application context. A reference may be held, but must be cleared on recycle.</dd>
-<dd><code>uri</code> - URI of the image.</dd>
+<dd><code>context</code> - Application context</dd>
+<dd><code>uri</code> - URI of the image</dd>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>Dimensions of the image.</dd>
+<dd>the decoded bitmap</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>java.lang.Exception</code> - if initialisation fails.</dd>
+<dd><code>java.lang.Exception</code> - if decoding fails.</dd>
</dl>
</li>
</ul>
diff --git a/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html b/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html
index d1e83e4..2a5fff7 100644
--- a/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html
+++ b/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html
@@ -128,7 +128,8 @@
<td class="colFirst"><code>android.graphics.Bitmap</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html#decodeRegion-android.graphics.Rect-int-">decodeRegion</a></span>(android.graphics.Rect sRect,
int sampleSize)</code>
-<div class="block">Decode a region of the image with the given sample size.</div>
+<div class="block">
+ Decode a region of the image with the given sample size.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
@@ -174,11 +175,14 @@
<pre>android.graphics.Point init(android.content.Context context,
android.net.Uri uri)
throws java.lang.Exception</pre>
-<div class="block">Initialise the decoder. When possible, initial setup work once in this method. This method
- must return the dimensions of the image. The URI can be in one of the following formats:
- File: file:///scard/picture.jpg
- Asset: file:///android_asset/picture.png
- Resource: android.resource://com.example.app/drawable/picture</div>
+<div class="block">Initialise the decoder. When possible, perform initial setup work once in this method. The
+ dimensions of the image must be returned. The URI can be in one of the following formats:
+ <br>
+ File: <code>file:///scard/picture.jpg</code>
+ <br>
+ Asset: <code>file:///android_asset/picture.png</code>
+ <br>
+ Resource: <code>android.resource://com.example.app/drawable/picture</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - Application context. A reference may be held, but must be cleared on recycle.</dd>
@@ -198,10 +202,17 @@
<h4>decodeRegion</h4>
<pre>android.graphics.Bitmap decodeRegion(android.graphics.Rect sRect,
int sampleSize)</pre>
-<div class="block">Decode a region of the image with the given sample size. This method is called off the UI thread so it can safely
- load the image on the current thread. It is called from an <code>AsyncTask</code> running in a single
- threaded executor, and while a synchronization lock is held on this object, so will never be called concurrently
- even if the decoder implementation supports it.</div>
+<div class="block"><p>
+ Decode a region of the image with the given sample size. This method is called off the UI
+ thread so it can safely load the image on the current thread. It is called from
+ <code>AsyncTask</code>s running in an executor that may have multiple threads, so
+ implementations must be thread safe. Adding <code>synchronized</code> to the method signature
+ is the simplest way to achieve this, but bear in mind the <a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html#recycle--"><code>recycle()</code></a> method can be
+ called concurrently.
+ </p><p>
+ See <a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/SkiaImageRegionDecoder.html" title="class in com.davemorrissey.labs.subscaleview.decoder"><code>SkiaImageRegionDecoder</code></a> and <a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/SkiaPooledImageRegionDecoder.html" title="class in com.davemorrissey.labs.subscaleview.decoder"><code>SkiaPooledImageRegionDecoder</code></a> for examples of
+ internal locking and synchronization.
+ </p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sRect</code> - Source image rectangle to decode.</dd>
diff --git a/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/SkiaImageDecoder.html b/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/SkiaImageDecoder.html
index 23f03e0..3e3314f 100644
--- a/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/SkiaImageDecoder.html
+++ b/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/SkiaImageDecoder.html
@@ -221,21 +221,23 @@
android.net.Uri uri)
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageDecoder.html#decode-android.content.Context-android.net.Uri-">ImageDecoder</a></code></span></div>
-<div class="block">Decode an image. When possible, initial setup work once in this method. This method
- must return the dimensions of the image. The URI can be in one of the following formats:
- File: file:///scard/picture.jpg
- Asset: file:///android_asset/picture.png
- Resource: android.resource://com.example.app/drawable/picture</div>
+<div class="block">Decode an image. The URI can be in one of the following formats:
+ <br>
+ File: <code>file:///scard/picture.jpg</code>
+ <br>
+ Asset: <code>file:///android_asset/picture.png</code>
+ <br>
+ Resource: <code>android.resource://com.example.app/drawable/picture</code></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageDecoder.html#decode-android.content.Context-android.net.Uri-">decode</a></code> in interface <code><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder">ImageDecoder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>context</code> - Application context. A reference may be held, but must be cleared on recycle.</dd>
-<dd><code>uri</code> - URI of the image.</dd>
+<dd><code>context</code> - Application context</dd>
+<dd><code>uri</code> - URI of the image</dd>
<dt><span class="returnLabel">Returns:</span></dt>
-<dd>Dimensions of the image.</dd>
+<dd>the decoded bitmap</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>java.lang.Exception</code> - if initialisation fails.</dd>
+<dd><code>java.lang.Exception</code> - if decoding fails.</dd>
</dl>
</li>
</ul>
diff --git a/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/SkiaImageRegionDecoder.html b/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/SkiaImageRegionDecoder.html
index b069121..7c3ffef 100644
--- a/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/SkiaImageRegionDecoder.html
+++ b/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/SkiaImageRegionDecoder.html
@@ -165,7 +165,8 @@
<td class="colFirst"><code>android.graphics.Bitmap</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/SkiaImageRegionDecoder.html#decodeRegion-android.graphics.Rect-int-">decodeRegion</a></span>(android.graphics.Rect sRect,
int sampleSize)</code>
-<div class="block">Decode a region of the image with the given sample size.</div>
+<div class="block">
+ Decode a region of the image with the given sample size.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
@@ -245,11 +246,14 @@
android.net.Uri uri)
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html#init-android.content.Context-android.net.Uri-">ImageRegionDecoder</a></code></span></div>
-<div class="block">Initialise the decoder. When possible, initial setup work once in this method. This method
- must return the dimensions of the image. The URI can be in one of the following formats:
- File: file:///scard/picture.jpg
- Asset: file:///android_asset/picture.png
- Resource: android.resource://com.example.app/drawable/picture</div>
+<div class="block">Initialise the decoder. When possible, perform initial setup work once in this method. The
+ dimensions of the image must be returned. The URI can be in one of the following formats:
+ <br>
+ File: <code>file:///scard/picture.jpg</code>
+ <br>
+ Asset: <code>file:///android_asset/picture.png</code>
+ <br>
+ Resource: <code>android.resource://com.example.app/drawable/picture</code></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html#init-android.content.Context-android.net.Uri-">init</a></code> in interface <code><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder">ImageRegionDecoder</a></code></dd>
@@ -272,10 +276,17 @@
<pre>public android.graphics.Bitmap decodeRegion(android.graphics.Rect sRect,
int sampleSize)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html#decodeRegion-android.graphics.Rect-int-">ImageRegionDecoder</a></code></span></div>
-<div class="block">Decode a region of the image with the given sample size. This method is called off the UI thread so it can safely
- load the image on the current thread. It is called from an <code>AsyncTask</code> running in a single
- threaded executor, and while a synchronization lock is held on this object, so will never be called concurrently
- even if the decoder implementation supports it.</div>
+<div class="block"><p>
+ Decode a region of the image with the given sample size. This method is called off the UI
+ thread so it can safely load the image on the current thread. It is called from
+ <code>AsyncTask</code>s running in an executor that may have multiple threads, so
+ implementations must be thread safe. Adding <code>synchronized</code> to the method signature
+ is the simplest way to achieve this, but bear in mind the <a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html#recycle--"><code>ImageRegionDecoder.recycle()</code></a> method can be
+ called concurrently.
+ </p><p>
+ See <a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/SkiaImageRegionDecoder.html" title="class in com.davemorrissey.labs.subscaleview.decoder"><code>SkiaImageRegionDecoder</code></a> and <a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/SkiaPooledImageRegionDecoder.html" title="class in com.davemorrissey.labs.subscaleview.decoder"><code>SkiaPooledImageRegionDecoder</code></a> for examples of
+ internal locking and synchronization.
+ </p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html#decodeRegion-android.graphics.Rect-int-">decodeRegion</a></code> in interface <code><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder">ImageRegionDecoder</a></code></dd>
diff --git a/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/package-summary.html b/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/package-summary.html
index ce29132..8805372 100644
--- a/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/package-summary.html
+++ b/docs/javadoc/com/davemorrissey/labs/subscaleview/decoder/package-summary.html
@@ -83,13 +83,13 @@
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/DecoderFactory.html" title="interface in com.davemorrissey.labs.subscaleview.decoder">DecoderFactory</a><T></td>
<td class="colLast">
-<div class="block">Interface for decoder (and region decoder) factories.</div>
+<div class="block">Interface for <a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder"><code>ImageDecoder</code></a> and <a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder"><code>ImageRegionDecoder</code></a> factories.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/davemorrissey/labs/subscaleview/decoder/ImageDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder">ImageDecoder</a></td>
<td class="colLast">
-<div class="block">Interface for image decoding classes, allowing the default <code>BitmapRegionDecoder</code>
+<div class="block">Interface for image decoding classes, allowing the default <code>BitmapFactory</code>
based on the Skia library to be replaced with a custom class.</div>
</td>
</tr>
diff --git a/docs/javadoc/index-all.html b/docs/javadoc/index-all.html
index 0c59348..eb270eb 100644
--- a/docs/javadoc/index-all.html
+++ b/docs/javadoc/index-all.html
@@ -143,7 +143,8 @@
<dd> </dd>
<dt><span class="memberNameLink"><a href="com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html#decodeRegion-android.graphics.Rect-int-">decodeRegion(Rect, int)</a></span> - Method in interface com.davemorrissey.labs.subscaleview.decoder.<a href="com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder">ImageRegionDecoder</a></dt>
<dd>
-<div class="block">Decode a region of the image with the given sample size.</div>
+<div class="block">
+ Decode a region of the image with the given sample size.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/davemorrissey/labs/subscaleview/decoder/SkiaImageRegionDecoder.html#decodeRegion-android.graphics.Rect-int-">decodeRegion(Rect, int)</a></span> - Method in class com.davemorrissey.labs.subscaleview.decoder.<a href="com/davemorrissey/labs/subscaleview/decoder/SkiaImageRegionDecoder.html" title="class in com.davemorrissey.labs.subscaleview.decoder">SkiaImageRegionDecoder</a></dt>
<dd> </dd>
@@ -154,7 +155,7 @@
</dd>
<dt><a href="com/davemorrissey/labs/subscaleview/decoder/DecoderFactory.html" title="interface in com.davemorrissey.labs.subscaleview.decoder"><span class="typeNameLink">DecoderFactory</span></a><<a href="com/davemorrissey/labs/subscaleview/decoder/DecoderFactory.html" title="type parameter in DecoderFactory">T</a>> - Interface in <a href="com/davemorrissey/labs/subscaleview/decoder/package-summary.html">com.davemorrissey.labs.subscaleview.decoder</a></dt>
<dd>
-<div class="block">Interface for decoder (and region decoder) factories.</div>
+<div class="block">Interface for <a href="com/davemorrissey/labs/subscaleview/decoder/ImageDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder"><code>ImageDecoder</code></a> and <a href="com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder"><code>ImageRegionDecoder</code></a> factories.</div>
</dd>
<dt><span class="memberNameLink"><a href="com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.DefaultOnAnimationEventListener.html#DefaultOnAnimationEventListener--">DefaultOnAnimationEventListener()</a></span> - Constructor for class com.davemorrissey.labs.subscaleview.<a href="com/davemorrissey/labs/subscaleview/SubsamplingScaleImageView.DefaultOnAnimationEventListener.html" title="class in com.davemorrissey.labs.subscaleview">SubsamplingScaleImageView.DefaultOnAnimationEventListener</a></dt>
<dd> </dd>
@@ -268,7 +269,7 @@
<dl>
<dt><a href="com/davemorrissey/labs/subscaleview/decoder/ImageDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder"><span class="typeNameLink">ImageDecoder</span></a> - Interface in <a href="com/davemorrissey/labs/subscaleview/decoder/package-summary.html">com.davemorrissey.labs.subscaleview.decoder</a></dt>
<dd>
-<div class="block">Interface for image decoding classes, allowing the default <code>BitmapRegionDecoder</code>
+<div class="block">Interface for image decoding classes, allowing the default <code>BitmapFactory</code>
based on the Skia library to be replaced with a custom class.</div>
</dd>
<dt><a href="com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.html" title="interface in com.davemorrissey.labs.subscaleview.decoder"><span class="typeNameLink">ImageRegionDecoder</span></a> - Interface in <a href="com/davemorrissey/labs/subscaleview/decoder/package-summary.html">com.davemorrissey.labs.subscaleview.decoder</a></dt>