Update doc comments

This commit is contained in:
david-swift 2024-09-02 07:22:57 +02:00
parent 46f5c3289b
commit 6eb346f4c8
11 changed files with 20 additions and 20 deletions

View File

@ -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()

View File

@ -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,

View File

@ -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,

View File

@ -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,

View File

@ -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,

View File

@ -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,

View File

@ -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,

View File

@ -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,

View File

@ -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,

View File

@ -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,

View File

@ -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,