From 97c80f2af37aa5b14bbf55a6ec560639883877de Mon Sep 17 00:00:00 2001
From: Armin <armin.schnabel@cyface.de>
Date: Thu, 14 Sep 2023 19:15:03 +0200
Subject: [PATCH] Add documentation

---
 .../main/kotlin/de/cyface/energy_settings/TrackingSettings.kt | 4 ----
 .../de/cyface/energy_settings/settings/EnergySettings.kt      | 4 ++++
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/energy_settings/src/main/kotlin/de/cyface/energy_settings/TrackingSettings.kt b/energy_settings/src/main/kotlin/de/cyface/energy_settings/TrackingSettings.kt
index 8d3e8a4..661328b 100644
--- a/energy_settings/src/main/kotlin/de/cyface/energy_settings/TrackingSettings.kt
+++ b/energy_settings/src/main/kotlin/de/cyface/energy_settings/TrackingSettings.kt
@@ -82,10 +82,6 @@ object TrackingSettings {
         dataStore = DataStoreFactory.create(
             serializer = SettingsSerializer,
             produceFile = { dataStoreFile },
-            // TODO [RFR-788]: Add a test to ensure version is not set to 1 if no SharedPreferences file exist
-            // TODO [RFR-788]: Add a test which ensures preferences migration works and not default values are used
-            // TODO [RFR-788]: Add a test where the version is already 1 and SharedPreferences file is found
-            // TODO [RFR-788]: Add a test where the version is 1 and ensure no migration is executed / defaults are set
             migrations = listOf(
                 PreferencesMigrationFactory.create(appContext),
                 StoreMigration()
diff --git a/energy_settings/src/main/kotlin/de/cyface/energy_settings/settings/EnergySettings.kt b/energy_settings/src/main/kotlin/de/cyface/energy_settings/settings/EnergySettings.kt
index 4fa912d..37babb1 100644
--- a/energy_settings/src/main/kotlin/de/cyface/energy_settings/settings/EnergySettings.kt
+++ b/energy_settings/src/main/kotlin/de/cyface/energy_settings/settings/EnergySettings.kt
@@ -25,6 +25,10 @@ import kotlinx.coroutines.flow.map
 /**
  * Settings used by this library.
  *
+ * We currently don't use a repository to abstract the interface of the data types from the data
+ * source. The reason for this is the class is very simple and we don't plan multiple data sources.
+ * If this changes, consider using the standard Android Architecture, see `MeasurementRepository`.
+ *
  * @author Armin Schnabel
  * @version 2.0.0
  * @since 3.3.4