diff --git a/app/src/main/java/org/communiquons/android/comunic/client/Account.java b/app/src/main/java/org/communiquons/android/comunic/client/Account.java index 7cfec7f..09451c1 100644 --- a/app/src/main/java/org/communiquons/android/comunic/client/Account.java +++ b/app/src/main/java/org/communiquons/android/comunic/client/Account.java @@ -12,6 +12,9 @@ import java.util.Objects; /** * Comunic account class * + * This class stores the account tokens + * + * @author Pierre HUBERT * Created by pierre on 10/29/17. */ diff --git a/app/src/main/java/org/communiquons/android/comunic/client/LoginActivity.java b/app/src/main/java/org/communiquons/android/comunic/client/LoginActivity.java index 1c06970..f28af0a 100644 --- a/app/src/main/java/org/communiquons/android/comunic/client/LoginActivity.java +++ b/app/src/main/java/org/communiquons/android/comunic/client/LoginActivity.java @@ -17,6 +17,12 @@ import java.util.ArrayList; import org.communiquons.android.comunic.client.api.*; +/** + * Login activity of the application + * + * @author Pierre HUBERT + */ + public class LoginActivity extends AppCompatActivity { /** diff --git a/app/src/main/java/org/communiquons/android/comunic/client/MainActivity.java b/app/src/main/java/org/communiquons/android/comunic/client/MainActivity.java index a0b2e9b..7a89f6b 100644 --- a/app/src/main/java/org/communiquons/android/comunic/client/MainActivity.java +++ b/app/src/main/java/org/communiquons/android/comunic/client/MainActivity.java @@ -11,6 +11,12 @@ import android.widget.Toast; import org.communiquons.android.comunic.client.api.APIRequestTask; + +/** + * Main activity of the application + * + * @author Pierre HUBERT + */ public class MainActivity extends AppCompatActivity { /** diff --git a/app/src/main/java/org/communiquons/android/comunic/client/Utilities.java b/app/src/main/java/org/communiquons/android/comunic/client/Utilities.java index 7de5149..b20222e 100644 --- a/app/src/main/java/org/communiquons/android/comunic/client/Utilities.java +++ b/app/src/main/java/org/communiquons/android/comunic/client/Utilities.java @@ -11,6 +11,7 @@ import java.io.FileOutputStream; /** * Application utilities * + * @author Pierre HUBERT * Created by pierre on 10/29/17. */ diff --git a/app/src/main/java/org/communiquons/android/comunic/client/api/APIPostData.java b/app/src/main/java/org/communiquons/android/comunic/client/api/APIPostData.java index 7b090fc..16f1039 100644 --- a/app/src/main/java/org/communiquons/android/comunic/client/api/APIPostData.java +++ b/app/src/main/java/org/communiquons/android/comunic/client/api/APIPostData.java @@ -5,6 +5,7 @@ import java.net.URLEncoder; /** * This class stores on parameter for a POST request * + * @author Pierre HUBERT * Created by pierre on 10/31/17. */ diff --git a/app/src/main/java/org/communiquons/android/comunic/client/api/APIRequestParameters.java b/app/src/main/java/org/communiquons/android/comunic/client/api/APIRequestParameters.java index 00b654d..cf870aa 100644 --- a/app/src/main/java/org/communiquons/android/comunic/client/api/APIRequestParameters.java +++ b/app/src/main/java/org/communiquons/android/comunic/client/api/APIRequestParameters.java @@ -5,8 +5,9 @@ import org.communiquons.android.comunic.client.api.APIPostData; import java.util.ArrayList; /** - * This class handles the setup of the parametres required to setup an API request + * This class handles the setup of the parameters required to setup an API request * + * @author Pierre HUBERT * Created by pierre on 10/31/17. */ diff --git a/app/src/main/java/org/communiquons/android/comunic/client/api/APIRequestTask.java b/app/src/main/java/org/communiquons/android/comunic/client/api/APIRequestTask.java index dfa932f..1620fc2 100644 --- a/app/src/main/java/org/communiquons/android/comunic/client/api/APIRequestTask.java +++ b/app/src/main/java/org/communiquons/android/comunic/client/api/APIRequestTask.java @@ -22,6 +22,12 @@ import java.net.URL; /** * Perform an API request on the server * + * API requests are made on a separate Thread using AsyncTask. + * + * The method requesting an API request has to implement the onPostExecute method in order to be + * able to have a personalized data process + * + * @author Pierre HUBERT * Created by pierre on 10/31/17. */ public abstract class APIRequestTask extends AsyncTask { diff --git a/app/src/main/java/org/communiquons/android/comunic/client/api/APIResponse.java b/app/src/main/java/org/communiquons/android/comunic/client/api/APIResponse.java index 6e5c48f..5a0dd27 100644 --- a/app/src/main/java/org/communiquons/android/comunic/client/api/APIResponse.java +++ b/app/src/main/java/org/communiquons/android/comunic/client/api/APIResponse.java @@ -6,6 +6,7 @@ import org.json.JSONObject; /** * Store and serve the response of an API request * + * @author Pierre HUBERT * Created by pierre on 10/31/17. */