adding public documentation

brightdigit · May 10, 2024 · cc2bd8b · cc2bd8b
1 parent 481c081
commit cc2bd8b
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 8 deletions.
diff --git a/Sources/FeatherQuill/Feature.swift b/Sources/FeatherQuill/Feature.swift
@@ -32,22 +32,21 @@
   import SwiftUI
 
   @Observable
+  /// Set of values for the Feature.
   public class Feature<ValueType, UserTypeValue: UserType> {
     private let featureValue: FeatureValue<ValueType>
     private let availability: FeatureAvailability<UserTypeValue>
 
+    /// Binding value to use for SwiftUI Views.
     public var bindingValue: Binding<ValueType> {
       featureValue.bindingValue
     }
 
+    /// Value of the Feature.
     public var value: ValueType {
       featureValue.value
     }
 
-    public var isAvailable: Bool {
-      availability.value
-    }
-
     fileprivate init(
       value: FeatureValue<ValueType>,
       availability: FeatureAvailability<UserTypeValue>
@@ -58,7 +57,7 @@
   }
 
   extension Feature {
-    public convenience init(
+    internal convenience init(
       key: String,
       defaultValue: ValueType,
       userType: UserTypeValue,

diff --git a/Sources/FeatherQuill/FeatureFlag.swift b/Sources/FeatherQuill/FeatureFlag.swift
@@ -69,18 +69,22 @@
       "\(Self.self)"
     }
 
+    /// Matching user for ``FeatureFlag
     public static var audience: UserTypeValue {
       .default
     }
 
+    /// Behavior options on how to handle changes.
     public static var options: AvailabilityOptions {
       .default
     }
 
+    /// The key the ``FeatureFlag``.
     public static var key: String {
       FeatureFlagSuffixes.key(from: typeName)
     }
 
+    /// The default value for the environment key.
     public static var defaultValue: FeatherQuill.Feature<ValueType, UserTypeValue> {
       .init(
         key: key,

diff --git a/Sources/FeatherQuill/FeatureValue.swift b/Sources/FeatherQuill/FeatureValue.swift
@@ -33,19 +33,19 @@
   import SwiftUI
 
   @Observable
-  public class FeatureValue<ValueType> {
+  internal class FeatureValue<ValueType> {
     private let userDefaults: UserDefaults
     private let key: String
     private let fullKey: String
-    public var bindingValue: Binding<ValueType> {
+    internal var bindingValue: Binding<ValueType> {
       .init {
         self._storedValue
       } set: { value in
         self._storedValue = value
       }
     }
 
-    public var value: ValueType {
+    internal var value: ValueType {
       let value = userDefaults.value(forKey: fullKey) as? ValueType
       assert(value != nil)
       return value ?? _storedValue