From 984972ffab4dd0bc9bf71ef21bd56963d598c101 Mon Sep 17 00:00:00 2001
From: cyBerta <cyberta@riseup.net>
Date: Sat, 7 Dec 2024 16:16:02 +0100
Subject: [PATCH] add javadoc to BitmaskCoreProvider

---
 .../leap/bitmaskclient/base/utils/BitmaskCoreProvider.java  | 6 ++++++
 1 file changed, 6 insertions(+)

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 9cd2a7470..77cf9cf0e 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());
-- 
GitLab