Doc: Added Javadoc on the two classes

Author: jarzul

simpledialogfragment/src/main/java/com/julienarzul/simpledialogfragment/SimpleDialogContent.java

@@ -6,7 +6,14 @@
 import com.google.auto.value.AutoValue;
 
 /**
- * Created by Julien Arzul on 13/12/2016.
+ * Immutable value class that represents the content of an AlertDialog shown with {@link SimpleDialogFragment}.
+ * The class is Parcelable in order to be given to the DialogFragment as a bundle argument.
+ * <p>
+ * Create an instance of this class with a {@link SimpleDialogContent.Builder}, retrieved through the static method
+ * {@link #builder()}.
+ * <p>
+ * The only required @NotNull field is the message of the dialog.
+ * <p>
  * Copyright @ Julien Arzul 2016
  */
 @AutoValue

simpledialogfragment/src/main/java/com/julienarzul/simpledialogfragment/SimpleDialogFragment.java

@@ -8,12 +8,36 @@
 import android.support.v4.app.DialogFragment;
 import android.support.v4.app.Fragment;
 import android.support.v4.app.FragmentActivity;
+import android.support.v4.app.FragmentManager;
 import android.support.v4.util.Pair;
 import android.support.v7.app.AlertDialog;
 import android.text.TextUtils;
 
 /**
- * Created by Julien Arzul on 09/11/2016.
+ * Simple implementation of a {@link DialogFragment} that allows you to specify the content of the {@link AlertDialog}
+ * displayed without subclassing it.
+ * <p>
+ * This DialogFragment must be instantiated with a {@link SimpleDialogContent} via the factory method {@link
+ * #newInstance(SimpleDialogContent)}
+ * <p>
+ * You can easily define listeners for the buttons set in the {@link SimpleDialogContent} with one of the two methods:
+ * <ul>
+ * <li>the enclosing activity must implement one or more of the listener interfaces</li>
+ * <li>the enclosing fragment must be set as the targetFragment of the {@link SimpleDialogFragment} and implement one
+ * or more of the listener interfaces</li>
+ * </ul>
+ * <p>
+ * There are three different listener interfaces that you can implement:
+ * <ul>
+ * <li>{@link OnPositiveButtonClickListener}</li>
+ * <li>{@link OnNegativeButtonClickListener}</li>
+ * <li>{@link OnNeutralButtonClickListener}</li>
+ * </ul>
+ * If the user chooses to listen to the click on the dialog's button, it is recommended to add a request code to the
+ * {@link SimpleDialogContent}. That request code will be given to the onClick method and will allow the user to
+ * determine which {@link SimpleDialogFragment} invoked the method. It is especially useful when a single {@link
+ * android.app.Activity} or {@link Fragment} needs to display several {@link SimpleDialogFragment}
+ * <p>
  * Copyright @ Julien Arzul 2016
  */
 public class SimpleDialogFragment extends DialogFragment implements DialogInterface.OnClickListener {
@@ -26,6 +50,16 @@ public class SimpleDialogFragment extends DialogFragment implements DialogInterf
 
     private SimpleDialogContent dialogContent = null;
 
+    /**
+     * Creates a new instance of a {@link SimpleDialogFragment}. It must be given a {@link SimpleDialogContent} to
+     * define the {@link AlertDialog} content.
+     *
+     * @param dialogContent Instance of {@link SimpleDialogContent} representing the content of the {@link AlertDialog}
+     *                      that will be displayed.
+     *
+     * @return A new instance of {@link SimpleDialogFragment}. Don't forget to call {{@link #show(FragmentManager,
+     * String)}} to actually display the {@link DialogFragment}
+     */
     public static SimpleDialogFragment newInstance(SimpleDialogContent dialogContent) {
         Bundle args = new Bundle();
 
@@ -128,18 +162,48 @@ private <T> Pair<T, Integer> getListener(Class<T> listenerClazz) {
         return null;
     }
 
+    /**
+     * Interface that must be implemented by the enclosing activity (or target fragment) in order to listen to click on
+     * the dialog positive's button.
+     */
     public interface OnPositiveButtonClickListener {
 
+        /**
+         * This method will be invoked when the positive button of the dialog is clicked.
+         *
+         * @param dialog      The dialog that received the click.
+         * @param requestCode The request code used to show the {@link SimpleDialogFragment}
+         */
         void onDialogPositiveButtonClicked(DialogInterface dialog, Integer requestCode);
     }
 
+    /**
+     * Interface that must be implemented by the enclosing activity (or target fragment) in order to listen to click on
+     * the dialog negative's button.
+     */
     public interface OnNegativeButtonClickListener {
 
+        /**
+         * This method will be invoked when the negative button of the dialog is clicked.
+         *
+         * @param dialog      The dialog that received the click.
+         * @param requestCode The request code used to show the {@link SimpleDialogFragment}
+         */
         void onDialogNegativeButtonClicked(DialogInterface dialog, Integer requestCode);
     }
 
+    /**
+     * Interface that must be implemented by the enclosing activity (or target fragment) in order to listen to click on
+     * the dialog neutral's button.
+     */
     public interface OnNeutralButtonClickListener {
 
+        /**
+         * This method will be invoked when the neutral button of the dialog is clicked.
+         *
+         * @param dialog      The dialog that received the click.
+         * @param requestCode The request code used to show the {@link SimpleDialogFragment}
+         */
         void onDialogNeutralButtonClicked(DialogInterface dialog, Integer requestCode);
     }
 }