document getPrimaryEmail method

wordpress-mobile · Jul 17, 2014 · a0e973c · a0e973c
1 parent d68fb87
commit a0e973c
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/WordPressUtils/src/main/java/org/wordpress/android/util/UserEmail.java b/WordPressUtils/src/main/java/org/wordpress/android/util/UserEmail.java
@@ -8,6 +8,11 @@
 import java.util.regex.Pattern;
 
 public class UserEmail {
+    /**
+     * Get primary account and return its name if it matches the email address pattern.
+     *
+     * @return primary account email address if it can be found or empty string else.
+     */
     public static String getPrimaryEmail(Context context) {
         try {
             AccountManager accountManager = AccountManager.get(context);