feat (doc) : mise à jour du readme & de la javadoc

mslimani · Nov 17, 2015 · 6662ed4 · 6662ed4
1 parent 59e1fd9
commit 6662ed4
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ Smoothy is inspired of [Butterknife][0] By [@JakeWharton][1]
 ```java
 class SecondActivity extends Activity {
   @BindExtra String username;
-  @BindExtra int count;
+  @BindExtra(optional = true) int count; // required by default
 
   @Override public void onCreate(Bundle savedInstanceState) {
     super.onCreate(savedInstanceState);
@@ -29,9 +29,11 @@ class FirstActivity extends Activity {
 
   public void displaySecondActivity() {
     // SecondActivityBuilder is generated by Smoothy with @BindExtra
-
-    Intent intent = new SecondActivityBuilder()
-                .username("mslimani")
+
+
+    // required field in constructor
+    // optional field in setter name
+    Intent intent = new SecondActivityBuilder("mslimani")
                 .count(10000)
                 .build(this);
 
@@ -41,12 +43,9 @@ class FirstActivity extends Activity {
 }
 ```
 
-Next Steps for v1.0.5
+Next Step v1.0.6
 --------
-- Add optional fields
-- Add default value
-- Add @BindExtra for others types : SparseArray, List<String>, BooleanArray, ByteArray, CharArray, DoubleArray, IntArray, StringArray, IBinder
-
+Optimisation, unit test
 
 Download
 --------
@@ -63,8 +62,8 @@ buildscript {
 apply plugin: 'com.neenbedankt.android-apt'
 
 dependencies {
-  compile 'com.github.mslimani:smoothy:1.0.4'
-  apt 'com.github.mslimani:smoothy-compiler:1.0.4'
+  compile 'com.github.mslimani:smoothy:1.0.5'
+  apt 'com.github.mslimani:smoothy-compiler:1.0.5'
 }
 ```
 

diff --git a/smoothy-annotations/src/main/java/smoothy/BindExtra.java b/smoothy-annotations/src/main/java/smoothy/BindExtra.java
@@ -9,8 +9,24 @@
 @Target(ElementType.FIELD)
 public @interface BindExtra {
 
+    /**
+     * @return true field in constructor builder else in setter name
+     */
     boolean optional() default false;
-    String value() default "";
-    //String defaultValue() default ""; // not implemented
 
+    /**
+     * <blockquote><pre>
+     * {@code
+     *     class MyActivity extends Activity {
+     *         @BindExtra(value = "intValue", optional = true) public int mInt;
+     *     }
+     *
+     *     Intent intent = MyActivityBuilder()
+     *                          .intValue(2)
+     *                          .build();
+     * }
+     * </pre></blockquote>
+     * @return default name for field in builder and setter name
+     */
+    String value() default "";
 }