Merge pull request square#393 from square/jw/doc-clarification

Clarify documentation on config to note it's a prefered value.

Author: dnkoutso

checkstyle.xml

@@ -57,7 +57,9 @@
     <module name="AvoidStarImport"/>
     <module name="IllegalImport"/>
     <module name="RedundantImport"/>
-    <module name="UnusedImports"/>
+    <module name="UnusedImports">
+      <property name="processJavadoc" value="true"/>
+    </module>
 
 
     <!-- Checks for Size Violations.                    -->

picasso/src/main/java/com/squareup/picasso/RequestCreator.java

@@ -17,6 +17,7 @@
 
 import android.content.res.Resources;
 import android.graphics.Bitmap;
+import android.graphics.BitmapFactory;
 import android.graphics.drawable.Drawable;
 import android.net.Uri;
 import android.widget.ImageView;
@@ -175,7 +176,12 @@ public RequestCreator rotate(float degrees, float pivotX, float pivotY) {
     return this;
   }
 
-  /** Decode the image using the specified config. */
+  /**
+   * Attempt to decode the image using the specified config.
+   * <p>
+   * Note: This value may be ignored by {@link BitmapFactory}. See
+   * {@link BitmapFactory.Options#inPreferredConfig its documentation for more details.
+   */
   public RequestCreator config(Bitmap.Config config) {
     data.config(config);
     return this;