Add documentation

cyface-de · Sep 14, 2023 · f0a91ff · f0a91ff
1 parent cc8ae32
commit f0a91ff
Showing 1 changed file with 4 additions and 0 deletions.
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