Update and fix the documentation

kiwicom · Sep 2, 2024 · 8485581 · 8485581
1 parent 5ee7ade
commit 8485581
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 14 deletions.
diff --git a/Sources/Orbit/Components/Text.swift b/Sources/Orbit/Components/Text.swift
@@ -21,7 +21,7 @@ import SwiftUI
 ///
 /// ### Localization
 /// 
-/// The localization follows the same pattern as the native ``SwiftUI.Text``.
+/// The localization follows the same pattern as the native ``SwiftUI/Text``.
 /// The default `main` bundle can be modified by using ``SwiftUI/View/localizationBundle(_:)`` modifier.
 ///
 /// ### Concatenation

diff --git a/Sources/Orbit/Orbit.docc/Components/Extensions/InputField.md b/Sources/Orbit/Orbit.docc/Components/Extensions/InputField.md
@@ -24,17 +24,18 @@
 
 ### Managing text entry
 
-- ``autocapitalization(_:)-6ecdh``
-- ``autocorrectionDisabled(_:)-7sz54``
-- ``keyboardType(_:)-1uu7i``
+- ``autocapitalization(_:)``
+- ``autocorrectionDisabled(_:)``
+- ``keyboardType(_:)``
 - ``returnKeyType(_:)``
 - ``shouldDeleteBackwardAction(_:)``
-- ``textContentType(_:)-4ng7o``
+- ``textContentType(_:)``
 
 ### UIKit components
 
 - ``TextField``
 - ``InsetableTextField``
+- ``TextFieldCoordinator``
 
 ### Customizing Appearance 
 

diff --git a/Sources/Orbit/Orbit.docc/Components/Extensions/Tag.md b/Sources/Orbit/Orbit.docc/Components/Extensions/Tag.md
@@ -9,5 +9,4 @@
 ### Customizing Appearance
 
 - ``TagButtonStyle``
-- ``TagStyle``
 - ``BackgroundShape``
diff --git a/Sources/Orbit/Orbit.docc/Components/Extensions/Textarea.md b/Sources/Orbit/Orbit.docc/Components/Extensions/Textarea.md
@@ -24,17 +24,18 @@
 
 ### Managing text entry
 
-- ``autocapitalization(_:)-9k9yh``
-- ``autocorrectionDisabled(_:)-4x1d6``
-- ``keyboardType(_:)-7khza``
+- ``autocapitalization(_:)``
+- ``autocorrectionDisabled(_:)``
+- ``keyboardType(_:)``
 - ``returnKeyType(_:)``
 - ``shouldDeleteBackwardAction(_:)``
-- ``textContentType(_:)-6etk6``
+- ``textContentType(_:)``
 
 ### UIKit components
 
 - ``TextView``
 - ``InsetableTextView``
+- ``TextFieldCoordinator``
 
 ### Customizing Appearance 
 

diff --git a/Sources/Orbit/Support/Forms/FieldWrapper.swift b/Sources/Orbit/Support/Forms/FieldWrapper.swift
@@ -33,8 +33,6 @@ public struct FieldWrapper<Label: View, Content: View, Footer: View>: View {
     }
 
     /// Creates Orbit ``FieldWrapper`` around form field content with a custom label and an additional message content.
-    ///
-    /// ``FieldLabel`` is a default component for constructing custom label.
     public init(
         message: Message? = nil,
         messageHeight: Binding<CGFloat> = .constant(0),

diff --git a/Sources/Orbit/Support/Layout/HorizontalScrollReader.swift b/Sources/Orbit/Support/Layout/HorizontalScrollReader.swift
@@ -6,7 +6,7 @@ public class HorizontalScrollViewProxy: ObservableObject {
 
     @Published fileprivate var scrollTarget: ScrollTargetValue?
 
-    /// Attempts to scroll to the item marked by Orbit ``identifier(_:)``.
+    /// Attempts to scroll to the item marked by Orbit ``SwiftUI/View/identifier(_:)``.
     /// 
     /// - Important: Animated variant may not be reliable when used in a quick succession.
     public func scrollTo(_ id: some Hashable, animated: Bool = true) {
@@ -17,7 +17,7 @@ public class HorizontalScrollViewProxy: ObservableObject {
 /// Orbit component that provides programmatic scrolling of ``HorizontalScroll`` component,
 /// by working with a ``HorizontalScrollViewProxy`` to scroll to child views marked by Orbit ``identifier(_:)`` modifier.
 /// 
-/// A  ``horizontalScrollPosition(id:)`` can be used instead for a bidirectional management of currently scrolled item.
+/// A  ``horizontalScrollPosition(id:animated:)`` can be used instead for a bidirectional management of currently scrolled item.
 @available(iOS 14, *)
 @available(iOS, obsoleted: 17.0, message: "Prefer using the native `ScrollViewReader`")
 public struct HorizontalScrollReader<Content: View>: View {