From 6eb346f4c81ab70e073c4b4d576c0d173c4a2010 Mon Sep 17 00:00:00 2001 From: david-swift Date: Mon, 2 Sep 2024 07:22:57 +0200 Subject: [PATCH] Update doc comments --- Sources/Model/Data Flow/Model.swift | 2 +- Sources/Model/Extensions/Array.swift | 4 ++-- Sources/Model/User Interface/View/AnyView.swift | 2 +- Sources/Model/User Interface/View/Widget.swift | 4 ++-- Sources/View/AppearObserver.swift | 4 ++-- Sources/View/ContentModifier.swift | 4 ++-- Sources/View/DummyEitherView.swift | 4 ++-- Sources/View/Freeze.swift | 4 ++-- Sources/View/InspectorWrapper.swift | 4 ++-- Sources/View/ModifierStopper.swift | 4 ++-- Sources/View/StateWrapper.swift | 4 ++-- 11 files changed, 20 insertions(+), 20 deletions(-) diff --git a/Sources/Model/Data Flow/Model.swift b/Sources/Model/Data Flow/Model.swift index cea2c78..331691d 100644 --- 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 { .init { getModel() diff --git a/Sources/Model/Extensions/Array.swift b/Sources/Model/Extensions/Array.swift index 7f5f7c2..6aee8bd 100644 --- 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( _ 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: WidgetData, diff --git a/Sources/Model/User Interface/View/AnyView.swift b/Sources/Model/User Interface/View/AnyView.swift index 91c75fa..3cec9f7 100644 --- 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( _ storage: ViewStorage, data: WidgetData, diff --git a/Sources/Model/User Interface/View/Widget.swift b/Sources/Model/User Interface/View/Widget.swift index e4da191..31199f1 100644 --- 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: 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( _ storage: ViewStorage, data: WidgetData, diff --git a/Sources/View/AppearObserver.swift b/Sources/View/AppearObserver.swift index 377a62f..035021a 100644 --- 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: 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( _ storage: ViewStorage, data: WidgetData, diff --git a/Sources/View/ContentModifier.swift b/Sources/View/ContentModifier.swift index 7e39440..d9708e9 100644 --- a/Sources/View/ContentModifier.swift +++ b/Sources/View/ContentModifier.swift @@ -16,7 +16,7 @@ struct ContentModifier: 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: WidgetData, @@ -30,7 +30,7 @@ struct ContentModifier: 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( _ storage: ViewStorage, data: WidgetData, diff --git a/Sources/View/DummyEitherView.swift b/Sources/View/DummyEitherView.swift index 84ac20e..f8b5841 100644 --- 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: 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( _ storage: ViewStorage, data: WidgetData, diff --git a/Sources/View/Freeze.swift b/Sources/View/Freeze.swift index 17a09c3..0d2ffda 100644 --- 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: 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( _ storage: ViewStorage, data: WidgetData, diff --git a/Sources/View/InspectorWrapper.swift b/Sources/View/InspectorWrapper.swift index e72caa1..1cd3bfb 100644 --- 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: 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( _ storage: ViewStorage, data: WidgetData, diff --git a/Sources/View/ModifierStopper.swift b/Sources/View/ModifierStopper.swift index 85066af..e93c753 100644 --- 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: 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( _ storage: ViewStorage, data: WidgetData, diff --git a/Sources/View/StateWrapper.swift b/Sources/View/StateWrapper.swift index 00d8f27..81e94c9 100644 --- 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( _ 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: WidgetData,