Rework the feature flag module.

Fix typo, rename class and interface, add doc, do small refacto, to improve code clarity.
2023-09-07 10:29:10 +02:00 · 2023-09-07 10:29:10 +02:00 · c16c875e68
commit c16c875e68
parent 4a5a01d710
8 changed files with 34 additions and 25 deletions
--- a/libraries/featureflag/api/src/main/kotlin/io/element/android/libraries/featureflag/api/FeatureFlagService.kt
+++ b/libraries/featureflag/api/src/main/kotlin/io/element/android/libraries/featureflag/api/FeatureFlagService.kt
@ -28,7 +28,8 @@ interface FeatureFlagService {
     * @param feature the feature to enable or disable
     * @param enabled true to enable the feature
     *
-     * @return true if the method succeeds, ie if a RuntimeFeatureFlagProvider is registered
+     * @return true if the method succeeds, ie if a [io.element.android.libraries.featureflag.impl.MutableFeatureFlagProvider]
+     * is registered
     */
    suspend fun setFeatureEnabled(feature: Feature, enabled: Boolean): Boolean
 }