Javadocfix (#127)

* fix javadocs missing descriptions

* fix silly misspellings..

* one more javadoc cleanup

Author: thomaszurkan-optimizely

datafile-handler/src/main/java/com/optimizely/ab/android/datafile_handler/DatafileHandler.java

@@ -45,7 +45,8 @@ public interface DatafileHandler {
     /**
      * Start background updates to the project datafile .
      *
-     * @param context        application context for download
+     * @param context application context for download
+     * @param projectId project id for background updates.
      * @param updateInterval frequency of updates in seconds
      */
     void startBackgroundUpdates(Context context, String projectId, Long updateInterval);
@@ -80,8 +81,8 @@ public interface DatafileHandler {
      * Has the file already been cached locally?
      *
      * @param context   application context for datafile cache
-     * @param projectId
-     * @return
+     * @param projectId projectId of the datafile
+     * @return true if the datafile is cached or false if not.
      */
     Boolean isDatafileSaved(Context context, String projectId);
 

datafile-handler/src/main/java/com/optimizely/ab/android/datafile_handler/DatafileLoadedListener.java

@@ -29,16 +29,17 @@
 public interface DatafileLoadedListener {
 
     /**
-     * Called with new datafile
+     * Called with new datafile after a download.
      *
      * @param dataFile the datafile json, can be null if datafile loading failed.
      *
      */
      void onDatafileLoaded(@Nullable String dataFile);
 
     /**
+     * The datafile download stopped for some reason.
      *
-     * @param context
+     * @param context application context
      */
      void onStop(Context context);
 }

user-profile/src/main/java/com/optimizely/ab/android/user_profile/UserProfileCacheUtils.java

@@ -35,8 +35,9 @@ public class UserProfileCacheUtils {
     /**
      * Transform a user profile JSONObject to a user profile map.
      *
-     * @param userProfilesJson
-     * @return
+     * @param userProfilesJson JSONObject representing the user profile from UserProfileService
+     * @return map of user id key and experiments with variations the user has participated in.
+     * @throws JSONException Exception if there is a json parsing problem
      */
     public static Map<String, Map<String, Object>> convertJSONObjectToMap(JSONObject userProfilesJson) throws
             JSONException {
@@ -74,9 +75,9 @@ public static Map<String, Map<String, Object>> convertJSONObjectToMap(JSONObject
     /**
      * Transform a user profile map to a user profile JSONObject.
      *
-     * @param userProfilesMap
-     * @return
-     * @throws Exception
+     * @param userProfilesMap map with user id as key and experiments variation map from there.
+     * @return JSONObject of the user profile service
+     * @throws Exception if the json is malformed or the map is malformed, an exception can occur.
      */
     public static JSONObject convertMapToJSONObject(Map<String, Map<String, Object>> userProfilesMap) throws Exception {
         JSONObject userProfilesJson = new JSONObject();