Add documentation

cyface-de · Sep 14, 2023 · 97c80f2 · 97c80f2
1 parent cc8ae32
commit 97c80f2
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 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
@@ -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
@@ -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