Update doc comments

AparokshaUI · Sep 2, 2024 · 6eb346f · 6eb346f
1 parent 46f5c32
commit 6eb346f
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 20 deletions.
diff --git a/Sources/Model/Data Flow/Model.swift b/Sources/Model/Data Flow/Model.swift
@@ -70,7 +70,7 @@ public struct ModelData {
 /// Extend the model.
 extension Model {
 
-    /// Get the value as a binding using the `$` prefix.
+    /// Get the value as a binding.
     public var binding: Binding<Self> {
         .init {
             getModel()

diff --git a/Sources/Model/Extensions/Array.swift b/Sources/Model/Extensions/Array.swift
@@ -38,7 +38,7 @@ extension Array: AnyView where Element == AnyView {
     ///     - storages: The collection of view storages.
     ///     - data: Modify views before being updated.
     ///     - updateProperties: Whether to update properties.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     public func update<Data>(
         _ storages: [ViewStorage],
         data: WidgetData,
@@ -57,7 +57,7 @@ extension Array: AnyView where Element == AnyView {
     /// Get the view storages of a collection of views.
     /// - Parameters:
     ///     - data: Modify views before generating the storages.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     /// - Returns: The storages.
     public func storages<Data>(
         data: WidgetData,

diff --git a/Sources/Model/User Interface/View/AnyView.swift b/Sources/Model/User Interface/View/AnyView.swift
@@ -32,7 +32,7 @@ extension AnyView {
     ///     - storage: The storage.
     ///     - data: Modify views before being updated.
     ///     - updateProperties: Whether to update properties.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     public func updateStorage<Data>(
         _ storage: ViewStorage,
         data: WidgetData,

diff --git a/Sources/Model/User Interface/View/Widget.swift b/Sources/Model/User Interface/View/Widget.swift
@@ -14,7 +14,7 @@ public protocol Widget: AnyView {
     /// The view storage.
     /// - Parameters:
     ///     - data: Modify views before being updated.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     /// - Returns: The view storage.
     func container<Data>(
         data: WidgetData,
@@ -26,7 +26,7 @@ public protocol Widget: AnyView {
     ///     - storage: The storage to update.
     ///     - data: Modify views before being updated
     ///     - updateProperties: Whether to update the view's properties.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     func update<Data>(
         _ storage: ViewStorage,
         data: WidgetData,

diff --git a/Sources/View/AppearObserver.swift b/Sources/View/AppearObserver.swift
@@ -16,7 +16,7 @@ struct AppearObserver: ConvenienceWidget {
     /// The view storage.
     /// - Parameters:
     ///     - data: Modify views before being updated.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     /// - Returns: The view storage.
     func container<Data>(
         data: WidgetData,
@@ -32,7 +32,7 @@ struct AppearObserver: ConvenienceWidget {
     ///     - storage: The storage to update.
     ///     - data: Modify views before being updated
     ///     - updateProperties: Whether to update the view's properties.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     func update<Data>(
         _ storage: ViewStorage,
         data: WidgetData,

diff --git a/Sources/View/ContentModifier.swift b/Sources/View/ContentModifier.swift
@@ -16,7 +16,7 @@ struct ContentModifier<Content>: ConvenienceWidget where Content: AnyView {
     /// The view storage.
     /// - Parameters:
     ///     - data: Modify views before being updated.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     /// - Returns: The view storage.
     func container<Data>(
         data: WidgetData,
@@ -30,7 +30,7 @@ struct ContentModifier<Content>: ConvenienceWidget where Content: AnyView {
     ///     - storage: The storage to update.
     ///     - data: Modify views before being updated
     ///     - updateProperties: Whether to update the view's properties.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     func update<Data>(
         _ storage: ViewStorage,
         data: WidgetData,

diff --git a/Sources/View/DummyEitherView.swift b/Sources/View/DummyEitherView.swift
@@ -18,7 +18,7 @@ struct DummyEitherView: ConvenienceWidget {
     /// The view storage.
     /// - Parameters:
     ///     - data: Modify views before being updated.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     /// - Returns: The view storage.
     func container<Data>(
         data: WidgetData,
@@ -34,7 +34,7 @@ struct DummyEitherView: ConvenienceWidget {
     ///     - storage: The storage to update.
     ///     - data: Modify views before being updated
     ///     - updateProperties: Whether to update the view's properties.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     func update<Data>(
         _ storage: ViewStorage,
         data: WidgetData,

diff --git a/Sources/View/Freeze.swift b/Sources/View/Freeze.swift
@@ -16,7 +16,7 @@ struct Freeze: ConvenienceWidget {
     /// The view storage.
     /// - Parameters:
     ///     - data: Modify views before being updated.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     /// - Returns: The view storage.
     func container<Data>(
         data: WidgetData,
@@ -30,7 +30,7 @@ struct Freeze: ConvenienceWidget {
     ///     - storage: The storage to update.
     ///     - data: Modify views before being updated
     ///     - updateProperties: Whether to update the view's properties.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     func update<Data>(
         _ storage: ViewStorage,
         data: WidgetData,

diff --git a/Sources/View/InspectorWrapper.swift b/Sources/View/InspectorWrapper.swift
@@ -16,7 +16,7 @@ struct InspectorWrapper: ConvenienceWidget {
     /// The view storage.
     /// - Parameters:
     ///     - data: Modify views before being updated.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     /// - Returns: The view storage.
     func container<Data>(
         data: WidgetData,
@@ -32,7 +32,7 @@ struct InspectorWrapper: ConvenienceWidget {
     ///     - storage: The storage to update.
     ///     - data: Modify views before being updated
     ///     - updateProperties: Whether to update the view's properties.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     func update<Data>(
         _ storage: ViewStorage,
         data: WidgetData,

diff --git a/Sources/View/ModifierStopper.swift b/Sources/View/ModifierStopper.swift
@@ -14,7 +14,7 @@ struct ModifierStopper: ConvenienceWidget {
     /// The view storage.
     /// - Parameters:
     ///     - data: Modify views before being updated.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     /// - Returns: The view storage.
     func container<Data>(
         data: WidgetData,
@@ -28,7 +28,7 @@ struct ModifierStopper: ConvenienceWidget {
     ///     - storage: The storage to update.
     ///     - data: Modify views before being updated
     ///     - updateProperties: Whether to update the view's properties.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     func update<Data>(
         _ storage: ViewStorage,
         data: WidgetData,

diff --git a/Sources/View/StateWrapper.swift b/Sources/View/StateWrapper.swift
@@ -33,7 +33,7 @@ struct StateWrapper: ConvenienceWidget {
     ///     - storage: The view storage.
     ///     - data: Modify views before being updated.
     ///     - updateProperties: Whether to update properties.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     /// - Returns: The view storage.
     func update<Data>(
         _ storage: ViewStorage,
@@ -60,7 +60,7 @@ struct StateWrapper: ConvenienceWidget {
     /// Get a view storage.
     /// - Parameters:
     ///     - data: Modify views before being updated.
-    ///     - type: The type of the app storage.
+    ///     - type: The view render data type.
     /// - Returns: The view storage.
     func container<Data>(
         data: WidgetData,