add javadoc comments

crashfiredeep · Jul 26, 2018 · 930c7b8 · 930c7b8
1 parent 8fe2be8
commit 930c7b8
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 10 deletions.
diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
@@ -8,4 +8,6 @@
         android:targetSdkVersion="21" />
     <uses-permission android:name="android.permission.CALL_PHONE"/>-->
 
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
+    <uses-permission android:name="android.permission.CALL_PHONE"/>
 </manifest>
diff --git a/app/src/main/java/com/ae/apps/common/services/AeContactService.java b/app/src/main/java/com/ae/apps/common/services/AeContactService.java
@@ -15,15 +15,15 @@
  */
 package com.ae.apps.common.services;
 
-import java.io.InputStream;
-import java.util.List;
-
 import android.graphics.Bitmap;
 
 import com.ae.apps.common.vo.ContactVo;
 import com.ae.apps.common.vo.MessageVo;
 import com.ae.apps.common.vo.PhoneNumberVo;
 
+import java.io.InputStream;
+import java.util.List;
+
 /**
  * Specification for a DAO that accesses the Android Contacts API
  */
@@ -80,7 +80,7 @@ public interface AeContactService {
     /**
      * Opens a contact photo?
      *
-     * See if you could use @LINK{getContactPhoto()} instead
+     * See if you could use getContactPhoto instead
      *
      * @param contactId contactId
      * @return contact photo

diff --git a/app/src/main/java/com/ae/apps/common/utils/ContactUtils.java b/app/src/main/java/com/ae/apps/common/utils/ContactUtils.java
@@ -28,6 +28,7 @@ public class ContactUtils {
      *
      * @param phoneNumbers  phone numbers
      * @param numberToCheck number to check
+     * @return true if phone number exists
      */
     public static boolean checkIfPhoneNumberExists(final List<String> phoneNumbers, final String numberToCheck) {
         String unformattedNumber = cleanupPhoneNumber(numberToCheck);
@@ -60,6 +61,7 @@ public static String cleanupPhoneNumber(String formattedPhoneNumber) {
     /**
      * Shows this contact in the Android's Contact Manager
      *
+     * @param context the context
      * @param contactId contactId
      */
     public static void showContactInAddressBook(Context context, String contactId) {

diff --git a/app/src/main/java/com/ae/apps/common/utils/IntentUtils.java b/app/src/main/java/com/ae/apps/common/utils/IntentUtils.java
@@ -14,24 +14,50 @@ public static class EmailIntentBuilder {
         private String mSubject;
         private String mBody;
 
+        /**
+         * Create a new instance of the builder
+         */
         public EmailIntentBuilder() {
         }
 
+        /**
+         * set the to address
+         *
+         * @param to to address
+         * @return this instance
+         */
         public EmailIntentBuilder to(String to) {
             mTo = to;
             return this;
         }
 
+        /**
+         * set the subject
+         *
+         * @param subject the email subject
+         * @return this instance
+         */
         public EmailIntentBuilder subject(String subject) {
             mSubject = subject;
             return this;
         }
 
+        /**
+         * set the body
+         *
+         * @param body the email body
+         * @return this instance
+         */
         public EmailIntentBuilder body(String body) {
             mBody = body;
             return this;
         }
 
+        /**
+         * get the intent for an email
+         *
+         * @return the intent
+         */
         public Intent get() {
             Intent intent = new Intent(Intent.ACTION_SENDTO);
             intent.setType("text/html");

diff --git a/app/src/main/java/com/ae/apps/common/utils/MobileNetworkUtils.java b/app/src/main/java/com/ae/apps/common/utils/MobileNetworkUtils.java
@@ -52,16 +52,15 @@ public static boolean isInternetAvailable(Context context) {
 		ConnectivityManager connectivityManager = (ConnectivityManager) context
 				.getSystemService(Context.CONNECTIVITY_SERVICE);
 
-		NetworkInfo networkInfo = connectivityManager.getActiveNetworkInfo();
+		NetworkInfo networkInfo = connectivityManager != null ?
+				connectivityManager.getActiveNetworkInfo() : null;
 
 		// Check the current state of the Network Information
 		if (networkInfo == null)
 			return false;
 		if (!networkInfo.isConnected())
 			return false;
-		if (!networkInfo.isAvailable())
-			return false;
-		return true;
+		return networkInfo.isAvailable();
 	}
 
 	/**

diff --git a/app/src/main/java/com/ae/apps/common/utils/ValueComparator.java b/app/src/main/java/com/ae/apps/common/utils/ValueComparator.java
@@ -6,8 +6,8 @@
 /**
  * Comparator that can be used for sorting a map based on the values
  *
- * @param <K>
- * @param <V>
+ * @param <K> k
+ * @param <V> v
  */
 public class ValueComparator<K, V extends Comparable<V>> implements Comparator<K> {