From 15de5dec6d2b3e2fc88ddb22613159123451a171 Mon Sep 17 00:00:00 2001 From: Alex Guretzki Date: Mon, 16 Oct 2023 11:34:00 +0200 Subject: [PATCH] Updating documentation --- Adyen/UI/List/ListItem.swift | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/Adyen/UI/List/ListItem.swift b/Adyen/UI/List/ListItem.swift index 73826e987b..9f1d581f86 100644 --- a/Adyen/UI/List/ListItem.swift +++ b/Adyen/UI/List/ListItem.swift @@ -36,10 +36,12 @@ public class ListItem: FormItem { /// The `accessibilityIdentifier` to be used on the `ListItem` public var identifier: String? - /// The `accessibilityLabel` to be used on the `ListItem` or ``ListCell`` + /// The `accessibilityLabel` to be used on the ``ListItem`` or ``ListCell`` public let accessibilityLabel: String - /// The handler to invoke when an item changes its loading state + /// The closure for the ``ListViewController`` to assign, to listen to updates for its loading state + /// + /// See: ``ListItem/startLoading()`` & ``ListItem/stopLoading()`` internal var loadingHandler: ((Bool, ListItem) -> Void)? /// Initializes the list item. @@ -77,14 +79,14 @@ public class ListItem: FormItem { builder.build(with: self) } - /// Indicates to the ``ListViewController`` that the specific item is currently loading + /// Indicate to the ``ListViewController`` to start loading / show the loading indicator for this specific item /// - /// To stop the loading for the whole list either ``stopLoading()`` on the ``ListViewController`` or on the ``ListItem`` + /// To stop the loading for the whole list either call ListViewController.``ListViewController/stopLoading()`` or ListItem.``ListItem/stopLoading()`` public func startLoading() { setLoading(true) } - /// Indicates that the ``ListViewController`` should stop loading + /// Indicate to the ``ListViewController`` to stop loading public func stopLoading() { setLoading(false) }