Update doc comments
This commit is contained in:
parent
46f5c3289b
commit
6eb346f4c8
@ -70,7 +70,7 @@ public struct ModelData {
|
|||||||
/// Extend the model.
|
/// Extend the model.
|
||||||
extension Model {
|
extension Model {
|
||||||
|
|
||||||
/// Get the value as a binding using the `$` prefix.
|
/// Get the value as a binding.
|
||||||
public var binding: Binding<Self> {
|
public var binding: Binding<Self> {
|
||||||
.init {
|
.init {
|
||||||
getModel()
|
getModel()
|
||||||
|
|||||||
@ -38,7 +38,7 @@ extension Array: AnyView where Element == AnyView {
|
|||||||
/// - storages: The collection of view storages.
|
/// - storages: The collection of view storages.
|
||||||
/// - data: Modify views before being updated.
|
/// - data: Modify views before being updated.
|
||||||
/// - updateProperties: Whether to update properties.
|
/// - updateProperties: Whether to update properties.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
public func update<Data>(
|
public func update<Data>(
|
||||||
_ storages: [ViewStorage],
|
_ storages: [ViewStorage],
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
@ -57,7 +57,7 @@ extension Array: AnyView where Element == AnyView {
|
|||||||
/// Get the view storages of a collection of views.
|
/// Get the view storages of a collection of views.
|
||||||
/// - Parameters:
|
/// - Parameters:
|
||||||
/// - data: Modify views before generating the storages.
|
/// - data: Modify views before generating the storages.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
/// - Returns: The storages.
|
/// - Returns: The storages.
|
||||||
public func storages<Data>(
|
public func storages<Data>(
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
|
|||||||
@ -32,7 +32,7 @@ extension AnyView {
|
|||||||
/// - storage: The storage.
|
/// - storage: The storage.
|
||||||
/// - data: Modify views before being updated.
|
/// - data: Modify views before being updated.
|
||||||
/// - updateProperties: Whether to update properties.
|
/// - updateProperties: Whether to update properties.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
public func updateStorage<Data>(
|
public func updateStorage<Data>(
|
||||||
_ storage: ViewStorage,
|
_ storage: ViewStorage,
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
|
|||||||
@ -14,7 +14,7 @@ public protocol Widget: AnyView {
|
|||||||
/// The view storage.
|
/// The view storage.
|
||||||
/// - Parameters:
|
/// - Parameters:
|
||||||
/// - data: Modify views before being updated.
|
/// - data: Modify views before being updated.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
/// - Returns: The view storage.
|
/// - Returns: The view storage.
|
||||||
func container<Data>(
|
func container<Data>(
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
@ -26,7 +26,7 @@ public protocol Widget: AnyView {
|
|||||||
/// - storage: The storage to update.
|
/// - storage: The storage to update.
|
||||||
/// - data: Modify views before being updated
|
/// - data: Modify views before being updated
|
||||||
/// - updateProperties: Whether to update the view's properties.
|
/// - updateProperties: Whether to update the view's properties.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
func update<Data>(
|
func update<Data>(
|
||||||
_ storage: ViewStorage,
|
_ storage: ViewStorage,
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
|
|||||||
@ -16,7 +16,7 @@ struct AppearObserver: ConvenienceWidget {
|
|||||||
/// The view storage.
|
/// The view storage.
|
||||||
/// - Parameters:
|
/// - Parameters:
|
||||||
/// - data: Modify views before being updated.
|
/// - data: Modify views before being updated.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
/// - Returns: The view storage.
|
/// - Returns: The view storage.
|
||||||
func container<Data>(
|
func container<Data>(
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
@ -32,7 +32,7 @@ struct AppearObserver: ConvenienceWidget {
|
|||||||
/// - storage: The storage to update.
|
/// - storage: The storage to update.
|
||||||
/// - data: Modify views before being updated
|
/// - data: Modify views before being updated
|
||||||
/// - updateProperties: Whether to update the view's properties.
|
/// - updateProperties: Whether to update the view's properties.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
func update<Data>(
|
func update<Data>(
|
||||||
_ storage: ViewStorage,
|
_ storage: ViewStorage,
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
|
|||||||
@ -16,7 +16,7 @@ struct ContentModifier<Content>: ConvenienceWidget where Content: AnyView {
|
|||||||
/// The view storage.
|
/// The view storage.
|
||||||
/// - Parameters:
|
/// - Parameters:
|
||||||
/// - data: Modify views before being updated.
|
/// - data: Modify views before being updated.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
/// - Returns: The view storage.
|
/// - Returns: The view storage.
|
||||||
func container<Data>(
|
func container<Data>(
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
@ -30,7 +30,7 @@ struct ContentModifier<Content>: ConvenienceWidget where Content: AnyView {
|
|||||||
/// - storage: The storage to update.
|
/// - storage: The storage to update.
|
||||||
/// - data: Modify views before being updated
|
/// - data: Modify views before being updated
|
||||||
/// - updateProperties: Whether to update the view's properties.
|
/// - updateProperties: Whether to update the view's properties.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
func update<Data>(
|
func update<Data>(
|
||||||
_ storage: ViewStorage,
|
_ storage: ViewStorage,
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
|
|||||||
@ -18,7 +18,7 @@ struct DummyEitherView: ConvenienceWidget {
|
|||||||
/// The view storage.
|
/// The view storage.
|
||||||
/// - Parameters:
|
/// - Parameters:
|
||||||
/// - data: Modify views before being updated.
|
/// - data: Modify views before being updated.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
/// - Returns: The view storage.
|
/// - Returns: The view storage.
|
||||||
func container<Data>(
|
func container<Data>(
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
@ -34,7 +34,7 @@ struct DummyEitherView: ConvenienceWidget {
|
|||||||
/// - storage: The storage to update.
|
/// - storage: The storage to update.
|
||||||
/// - data: Modify views before being updated
|
/// - data: Modify views before being updated
|
||||||
/// - updateProperties: Whether to update the view's properties.
|
/// - updateProperties: Whether to update the view's properties.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
func update<Data>(
|
func update<Data>(
|
||||||
_ storage: ViewStorage,
|
_ storage: ViewStorage,
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
|
|||||||
@ -16,7 +16,7 @@ struct Freeze: ConvenienceWidget {
|
|||||||
/// The view storage.
|
/// The view storage.
|
||||||
/// - Parameters:
|
/// - Parameters:
|
||||||
/// - data: Modify views before being updated.
|
/// - data: Modify views before being updated.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
/// - Returns: The view storage.
|
/// - Returns: The view storage.
|
||||||
func container<Data>(
|
func container<Data>(
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
@ -30,7 +30,7 @@ struct Freeze: ConvenienceWidget {
|
|||||||
/// - storage: The storage to update.
|
/// - storage: The storage to update.
|
||||||
/// - data: Modify views before being updated
|
/// - data: Modify views before being updated
|
||||||
/// - updateProperties: Whether to update the view's properties.
|
/// - updateProperties: Whether to update the view's properties.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
func update<Data>(
|
func update<Data>(
|
||||||
_ storage: ViewStorage,
|
_ storage: ViewStorage,
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
|
|||||||
@ -16,7 +16,7 @@ struct InspectorWrapper: ConvenienceWidget {
|
|||||||
/// The view storage.
|
/// The view storage.
|
||||||
/// - Parameters:
|
/// - Parameters:
|
||||||
/// - data: Modify views before being updated.
|
/// - data: Modify views before being updated.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
/// - Returns: The view storage.
|
/// - Returns: The view storage.
|
||||||
func container<Data>(
|
func container<Data>(
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
@ -32,7 +32,7 @@ struct InspectorWrapper: ConvenienceWidget {
|
|||||||
/// - storage: The storage to update.
|
/// - storage: The storage to update.
|
||||||
/// - data: Modify views before being updated
|
/// - data: Modify views before being updated
|
||||||
/// - updateProperties: Whether to update the view's properties.
|
/// - updateProperties: Whether to update the view's properties.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
func update<Data>(
|
func update<Data>(
|
||||||
_ storage: ViewStorage,
|
_ storage: ViewStorage,
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
|
|||||||
@ -14,7 +14,7 @@ struct ModifierStopper: ConvenienceWidget {
|
|||||||
/// The view storage.
|
/// The view storage.
|
||||||
/// - Parameters:
|
/// - Parameters:
|
||||||
/// - data: Modify views before being updated.
|
/// - data: Modify views before being updated.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
/// - Returns: The view storage.
|
/// - Returns: The view storage.
|
||||||
func container<Data>(
|
func container<Data>(
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
@ -28,7 +28,7 @@ struct ModifierStopper: ConvenienceWidget {
|
|||||||
/// - storage: The storage to update.
|
/// - storage: The storage to update.
|
||||||
/// - data: Modify views before being updated
|
/// - data: Modify views before being updated
|
||||||
/// - updateProperties: Whether to update the view's properties.
|
/// - updateProperties: Whether to update the view's properties.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
func update<Data>(
|
func update<Data>(
|
||||||
_ storage: ViewStorage,
|
_ storage: ViewStorage,
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
|
|||||||
@ -33,7 +33,7 @@ struct StateWrapper: ConvenienceWidget {
|
|||||||
/// - storage: The view storage.
|
/// - storage: The view storage.
|
||||||
/// - data: Modify views before being updated.
|
/// - data: Modify views before being updated.
|
||||||
/// - updateProperties: Whether to update properties.
|
/// - updateProperties: Whether to update properties.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
/// - Returns: The view storage.
|
/// - Returns: The view storage.
|
||||||
func update<Data>(
|
func update<Data>(
|
||||||
_ storage: ViewStorage,
|
_ storage: ViewStorage,
|
||||||
@ -60,7 +60,7 @@ struct StateWrapper: ConvenienceWidget {
|
|||||||
/// Get a view storage.
|
/// Get a view storage.
|
||||||
/// - Parameters:
|
/// - Parameters:
|
||||||
/// - data: Modify views before being updated.
|
/// - data: Modify views before being updated.
|
||||||
/// - type: The type of the app storage.
|
/// - type: The view render data type.
|
||||||
/// - Returns: The view storage.
|
/// - Returns: The view storage.
|
||||||
func container<Data>(
|
func container<Data>(
|
||||||
data: WidgetData,
|
data: WidgetData,
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user