add javadoc to BitmaskCoreProvider

1 files changed, 6 insertions, 0 deletions

diff --git a/app/src/main/java/se/leap/bitmaskclient/base/utils/BitmaskCoreProvider.java b/app/src/main/java/se/leap/bitmaskclient/base/utils/BitmaskCoreProvider.java
index 9cd2a747..77cf9cf0 100644
--- a/app/src/main/java/se/leap/bitmaskclient/base/utils/BitmaskCoreProvider.java
+++ b/app/src/main/java/se/leap/bitmaskclient/base/utils/BitmaskCoreProvider.java
@@ -6,6 +6,12 @@ import mobilemodels.BitmaskMobileCore;
 
 public class BitmaskCoreProvider {
     private static BitmaskMobileCore customMobileCore;
+
+    /**
+     * Returns an empty BitmaskMobile instance, which can be currently only used to access
+     * bitmask-core's persistence layer API
+     * @return BitmaskMobileCore interface
+     */
     public static BitmaskMobileCore getBitmaskMobile() {
         if (customMobileCore == null) {
             return new BitmaskMobile(new PreferenceHelper.SharedPreferenceStore());