Skip to content

Commit 2f291d9

Browse files
committed
Update documentation
1 parent 22f4558 commit 2f291d9

File tree

10 files changed

+10
-12
lines changed

10 files changed

+10
-12
lines changed

Sources/SwiftUIKit/Data/CsvParser.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public class CsvParser {
3838
///
3939
/// - Parameters:
4040
/// - fileName: The name of the file to parse.
41-
/// - fileExtension: The extension of the file to parse.
41+
/// - ext: The extension of the file to parse.
4242
/// - bundle: The bundle in which the file is located.
4343
/// - componentSeparator: The separator that separates components on each line.
4444
public func parseCsvFile(

Sources/SwiftUIKit/Extensions/View+Label.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ public extension View {
1414
///
1515
/// - Parameters:
1616
/// - text: The label text.
17+
/// - bundle: An optional bundle.
1718
func label(
1819
_ text: LocalizedStringKey,
1920
bundle: Bundle? = nil

Sources/SwiftUIKit/Gestures/SwipeGestureViewModifier.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ public struct SwipeGestureViewModifier: ViewModifier {
2323
/// - maximumTime: The max time the gesture can be active before cancelling itself, by default `1`.
2424
/// - minimumDistance: The minimum distance in points the gesture must be dragged before it triggers, by default `10`.
2525
/// - maximumDistance: The maximum distance in points the gesture can be dragged before it cancels, by default `100_000`.
26+
/// - gestureTimer: The gesture time to use, by default a standard one.
2627
/// - up: The action to trigger when the user swipes up, if any.
2728
/// - left: The action to trigger when the user swipes left, if any.
2829
/// - right: The action to trigger when the user swipes right, if any.

Sources/SwiftUIKit/Loading/DotLoadingAnimationText.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ public struct DotLoadingAnimationText: View {
2121
///
2222
/// - Parameters:
2323
/// - text: The text to present.
24+
/// - bundle: The bundle of the localized text, if any.
2425
/// - dotCount: The max number of dots, by default `3`.
2526
/// - interval: The timer tick interval in seconds, by default `0.8`.
2627
public init(

Sources/SwiftUIKit/Pickers/ColorPickerBar+Config.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ public extension ColorPickerBar {
2020
///
2121
/// - Parameters:
2222
/// - addOpacityToPicker: Whether or not to add color picker opacity, by default `true`.
23+
/// - addResetButton: Whether to add a reset button, by default `false`.
24+
/// - resetButtonValue: The reset button value, if any.
2325
public init(
2426
addOpacityToPicker: Bool = true,
2527
addResetButton: Bool = false,

Sources/SwiftUIKit/Pickers/ImagePicker.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public struct ImagePicker: UIViewControllerRepresentable {
3838
/// Create an image picker.
3939
///
4040
/// - Parameters:
41-
/// - documentTypes: The uniform types to pick.
41+
/// - sourceType: The image source type to pick.
4242
/// - pickerConfig: A custom picker configuration, if any.
4343
/// - cancelAction: The cancel action to trigger, if any.
4444
/// - resultAction: The result action to trigger, if any.

Sources/SwiftUIKit/Pickers/ListPicker.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ public struct ListPicker<Item: Identifiable, ItemView: View>: View {
4747
/// Create a list picker with multiple sections.
4848
///
4949
/// - Parameters:
50-
/// - items: The items to list in the picker.
51-
/// - selection: The current selection.
50+
/// - sections: The sections to render.
51+
/// - selection: The selection binding.
5252
/// - animatedSelection: Whether or not to animate selections, by default `false`.
5353
/// - dismissAfterPick: Whether or not to dismiss the picker after picking, by default `false`.
5454
/// - listItem: A list view builder.

Sources/SwiftUIKit/Progress/CircularProgressBar.swift

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,6 @@ import SwiftUI
1111
/**
1212
This view displays progress as a circle progress view, with
1313
the progress text in the center of the circle.
14-
15-
``startAngle`` is the clockwise degrees from the circle top.
16-
If `0`, the arc starts from the top, if `90` the right, etc.
1714

1815
The view can be styled with a ``CircularProgressBar/Style``.
1916
There are some built-in styles to choose from. You can also

Sources/SwiftUIKit/SwiftUIKit.docc/SwiftUIKit.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,6 @@ SwiftUIKit is available under the MIT license. See the [LICENSE][License] file f
200200

201201
### Styles
202202

203-
- ``CornerRadiusStyle``
204-
- ``FontStyle``
205203
- ``ViewShadowStyle``
206204

207205
### Text
@@ -215,8 +213,6 @@ SwiftUIKit is available under the MIT license. See the [LICENSE][License] file f
215213

216214
- ``CustomRoundedRectangle``
217215
- ``EditableView``
218-
- ``FetchedDataView``
219-
- ``TextReplacement``
220216

221217

222218

Sources/SwiftUIKit/Text/LinkText.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import SwiftUI
1717
///
1818
/// You can use standard `.font` and `.foregroundStyle` view
1919
/// modifiers to style text and `.accentColor` to tint links.
20-
/// You can also use a ``LinkText/Style`` to style the links
20+
/// You can also use a ``LinkText/LinkStyle`` to style links
2121
/// further, making them bold or italic.
2222
public struct LinkText: View {
2323

0 commit comments

Comments
 (0)