Release 3.10.0 javadoc

davemorrissey · Mar 15, 2018 · b61c59e · b61c59e
1 parent 6b81b87
commit b61c59e
Show file tree

Hide file tree

Showing 34 changed files with 229 additions and 148 deletions.
diff --git a/docs/javadoc/allclasses-frame.html b/docs/javadoc/allclasses-frame.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (library 3.9.0 API)</title>
+<title>All Classes (library 3.10.0 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/javadoc/allclasses-noframe.html b/docs/javadoc/allclasses-noframe.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (library 3.9.0 API)</title>
+<title>All Classes (library 3.10.0 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/javadoc/com/davemorrissey/labs/subscaleview/ImageSource.html b/docs/javadoc/com/davemorrissey/labs/subscaleview/ImageSource.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>ImageSource (library 3.9.0 API)</title>
+<title>ImageSource (library 3.10.0 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="ImageSource (library 3.9.0 API)";
+            parent.document.title="ImageSource (library 3.10.0 API)";
         }
     }
     catch(err) {
@@ -259,7 +259,8 @@ <h3>Method Detail</h3>
 <ul class="blockList">
 <li class="blockList">
 <h4>resource</h4>
-<pre>public static&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;resource(int&nbsp;resId)</pre>
+<pre><a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+public static&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;resource(int&nbsp;resId)</pre>
 <div class="block">Create an instance from a resource. The correct resource for the device screen resolution will be used.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
@@ -275,7 +276,9 @@ <h4>resource</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>asset</h4>
-<pre>public static&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;asset(<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;assetName)</pre>
+<pre><a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+public static&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;asset(<a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+                                         <a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;assetName)</pre>
 <div class="block">Create an instance from an asset name.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
@@ -291,7 +294,9 @@ <h4>asset</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>uri</h4>
-<pre>public static&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;uri(<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)</pre>
+<pre><a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+public static&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;uri(<a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+                                       <a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)</pre>
 <div class="block">Create an instance from a URI. If the URI does not start with a scheme, it's assumed to be the URI
  of a file.</div>
 <dl>
@@ -308,7 +313,9 @@ <h4>uri</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>uri</h4>
-<pre>public static&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;uri(<a href="https://developer.android.com/reference/android/net/Uri.html?is-external=true" title="class or interface in android.net">Uri</a>&nbsp;uri)</pre>
+<pre><a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+public static&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;uri(<a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+                                       <a href="https://developer.android.com/reference/android/net/Uri.html?is-external=true" title="class or interface in android.net">Uri</a>&nbsp;uri)</pre>
 <div class="block">Create an instance from a URI.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
@@ -324,7 +331,9 @@ <h4>uri</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>bitmap</h4>
-<pre>public static&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;bitmap(<a href="https://developer.android.com/reference/android/graphics/Bitmap.html?is-external=true" title="class or interface in android.graphics">Bitmap</a>&nbsp;bitmap)</pre>
+<pre><a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+public static&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;bitmap(<a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+                                          <a href="https://developer.android.com/reference/android/graphics/Bitmap.html?is-external=true" title="class or interface in android.graphics">Bitmap</a>&nbsp;bitmap)</pre>
 <div class="block">Provide a loaded bitmap for display.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
@@ -340,7 +349,9 @@ <h4>bitmap</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>cachedBitmap</h4>
-<pre>public static&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;cachedBitmap(<a href="https://developer.android.com/reference/android/graphics/Bitmap.html?is-external=true" title="class or interface in android.graphics">Bitmap</a>&nbsp;bitmap)</pre>
+<pre><a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+public static&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;cachedBitmap(<a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+                                                <a href="https://developer.android.com/reference/android/graphics/Bitmap.html?is-external=true" title="class or interface in android.graphics">Bitmap</a>&nbsp;bitmap)</pre>
 <div class="block">Provide a loaded and cached bitmap for display. This bitmap will not be recycled when it is no
  longer needed. Use this method if you loaded the bitmap with an image loader such as Picasso
  or Volley.</div>
@@ -358,7 +369,8 @@ <h4>cachedBitmap</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>tilingEnabled</h4>
-<pre>public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;tilingEnabled()</pre>
+<pre><a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;tilingEnabled()</pre>
 <div class="block">Enable tiling of the image. This does not apply to preview images which are always loaded as a single bitmap.,
  and tiling cannot be disabled when displaying a region of the source image.</div>
 <dl>
@@ -373,7 +385,8 @@ <h4>tilingEnabled</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>tilingDisabled</h4>
-<pre>public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;tilingDisabled()</pre>
+<pre><a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;tilingDisabled()</pre>
 <div class="block">Disable tiling of the image. This does not apply to preview images which are always loaded as a single bitmap,
  and tiling cannot be disabled when displaying a region of the source image.</div>
 <dl>
@@ -388,7 +401,8 @@ <h4>tilingDisabled</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>tiling</h4>
-<pre>public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;tiling(boolean&nbsp;tile)</pre>
+<pre><a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;tiling(boolean&nbsp;tile)</pre>
 <div class="block">Enable or disable tiling of the image. This does not apply to preview images which are always loaded as a single bitmap,
  and tiling cannot be disabled when displaying a region of the source image.</div>
 <dl>
@@ -405,7 +419,8 @@ <h4>tiling</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>region</h4>
-<pre>public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;region(<a href="https://developer.android.com/reference/android/graphics/Rect.html?is-external=true" title="class or interface in android.graphics">Rect</a>&nbsp;sRegion)</pre>
+<pre><a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;region(<a href="https://developer.android.com/reference/android/graphics/Rect.html?is-external=true" title="class or interface in android.graphics">Rect</a>&nbsp;sRegion)</pre>
 <div class="block">Use a region of the source image. Region must be set independently for the full size image and the preview if
  you are using one.</div>
 <dl>
@@ -422,8 +437,9 @@ <h4>region</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>dimensions</h4>
-<pre>public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;dimensions(int&nbsp;sWidth,
-                              int&nbsp;sHeight)</pre>
+<pre><a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+public&nbsp;<a href="../../../../com/davemorrissey/labs/subscaleview/ImageSource.html" title="class in com.davemorrissey.labs.subscaleview">ImageSource</a>&nbsp;dimensions(int&nbsp;sWidth,
+                                       int&nbsp;sHeight)</pre>
 <div class="block">Declare the dimensions of the image. This is only required for a full size image, when you are specifying a URI
  and also a preview image. When displaying a bitmap object, or not using a preview, you do not need to declare
  the image dimensions. Note if the declared dimensions are found to be incorrect, the view will reset.</div>

diff --git a/docs/javadoc/com/davemorrissey/labs/subscaleview/ImageViewState.html b/docs/javadoc/com/davemorrissey/labs/subscaleview/ImageViewState.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>ImageViewState (library 3.9.0 API)</title>
+<title>ImageViewState (library 3.10.0 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="ImageViewState (library 3.9.0 API)";
+            parent.document.title="ImageViewState (library 3.10.0 API)";
         }
     }
     catch(err) {
@@ -197,6 +197,7 @@ <h3>Constructor Detail</h3>
 <li class="blockList">
 <h4>ImageViewState</h4>
 <pre>public&nbsp;ImageViewState(float&nbsp;scale,
+                      <a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
                       <a href="https://developer.android.com/reference/android/graphics/PointF.html?is-external=true" title="class or interface in android.graphics">PointF</a>&nbsp;center,
                       int&nbsp;orientation)</pre>
 </li>
@@ -224,7 +225,8 @@ <h4>getScale</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCenter</h4>
-<pre>public&nbsp;<a href="https://developer.android.com/reference/android/graphics/PointF.html?is-external=true" title="class or interface in android.graphics">PointF</a>&nbsp;getCenter()</pre>
+<pre><a href="https://developer.android.com/reference/android/support.annotation.NonNull.html?is-external=true" title="class or interface in android">@NonNull</a>
+public&nbsp;<a href="https://developer.android.com/reference/android/graphics/PointF.html?is-external=true" title="class or interface in android.graphics">PointF</a>&nbsp;getCenter()</pre>
 </li>
 </ul>
 <a name="getOrientation--">