Update documentation

danielsaidi · danielsaidi · commit afc154d4c81a · 2025-10-23T08:22:46.000+02:00
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -10,6 +10,10 @@ Until then, breaking changes can happen any minor version bump.
 
 This version bumps the package to Swift 6.1 and makes the demo app target iOS 26.
 
+### 💥 Breaking changes
+
+* All deprecated code has been removed.
+
 
 
 ## 0.8.1
diff --git a/Sources/ScrollKit/Examples/Examples+SpotifyAlbum.swift b/Sources/ScrollKit/Examples/Examples+SpotifyAlbum.swift
@@ -10,7 +10,7 @@ import SwiftUI
 
 public extension Examples.Spotify {
     
-    /// This model is used by the Spotify previews.
+    /// This struct represents a Spotify album.
     struct Album {
 
         public init(
diff --git a/Sources/ScrollKit/Examples/Examples.swift b/Sources/ScrollKit/Examples/Examples.swift
@@ -8,8 +8,6 @@
 
 import Foundation
 
-/// This is a namespace with various examples on how you can
-/// use this library to achieve certain effects.
-///
-/// For now, only `
+/// This is a namespace with various examples on how you can use this library to
+/// achieve certain effects.
 public struct Examples {}
diff --git a/Sources/ScrollKit/Extensions/View+RoundedScollContent.swift b/Sources/ScrollKit/Extensions/View+RoundedScollContent.swift
@@ -10,12 +10,11 @@ import SwiftUI
 
 public extension View {
     
-    /// Make a scroll view's content view overlap the scroll
-    /// header, by applying a negative offset.
+    /// Make a scroll view's content view overlap the scroll header by applying a
+    /// negative offset.
     ///
-    /// Do not use this together with a sticky header, since
-    /// a sticky header will overlap the content, which will
-    /// ruin this overlap effect.
+    /// Do not use this together with a sticky header, since such a sticky header
+    /// will overlap the content, which will ruin this overlap effect.
     ///
     /// - Parameters:
     ///   - points: The number of points to overlap, by default `10`.
@@ -29,12 +28,11 @@ public extension View {
 @available(iOS 16.0, macOS 13.0, tvOS 16.0, watchOS 9.0, *)
 public extension View {
     
-    /// Make a scroll view's content view overlap the scroll
-    /// header with rounded corners.
+    /// Make a scroll view's content view overlap the scroll header by applying a
+    /// custom rounded corner edge.
     ///
-    /// Do not use this together with a sticky header, since
-    /// a sticky header will overlap the content, which will
-    /// ruin this overlap effect.
+    /// Do not use this together with a sticky header, since such a sticky header
+    /// will overlap the content, which will ruin this overlap effect.
     ///
     /// - Parameters:
     ///   - points: The number of points to overlap, by default `10`.
@@ -49,8 +47,8 @@ public extension View {
             .scrollViewContentWithHeaderOverlap(overlap)
     }
         
-    /// Make a scroll view header view apply rounded corners
-    /// that cut out a mask for the scroll view content view.
+    /// Make a scroll view's header view apply rounded corners to the view that
+    /// follows it, by cutting out a mask for the scroll view content view.
     ///
     /// - Parameters:
     ///   - cornerRadius: The number of points to overlap, by default `0`.
diff --git a/Sources/ScrollKit/Helpers/ScrollManager.swift b/Sources/ScrollKit/Helpers/ScrollManager.swift
@@ -8,25 +8,20 @@
 
 import SwiftUI
 
-/// This class can be used for programmatic scrolling within
-/// a scroll view.
+/// This class can be used for programmatic scrolling within a scroll view.
 ///
-/// This class can be used to scroll to any specific part of
-/// a scroll view (e.g. the header or the main content) with
-/// a `ScrollViewProxy`. Simply add a ``ScrollTarget`` ID to
-/// your scroll view's header view and content then call any
-/// manager instance's ``setProxy(_:)`` with the scroll view
-/// proxy from any scroll view reader in your view.
+/// This manager can be used to scroll to a specific part of a scroll view's content,
+/// like the header view, or the main content view, usinc a `ScrollViewProxy`.
 ///
-/// Once everything's done, you can use ``scroll(to:anchor:)``
-/// to scroll to any defined targets within your scroll view.
+/// To use this, simply add a ``ScrollTarget`` ID to your scroll view's header
+/// view and content then call any manager instance's ``setProxy(_:)`` with
+/// the scroll view proxy from any scroll view reader in your view.
 ///
-/// The ``ScrollViewWithStickyHeader`` has support for using
-/// this manager, but you can add it to any custom view.
+/// You can then use ``scroll(to:anchor:)`` to scroll to any targets within
+/// your scroll view's content view.
 ///
-/// - Important: The manager uses a `ScrollViewReader` under
-/// the hood, so yoyr scroll view must apply valid `.id(...)`
-/// values to the header and content.
+/// > Important: The scroll manager uses a `ScrollViewReader`, so the scroll
+/// view must apply valid `.id(...)` values to the header and its content.
 public class ScrollManager {
 
     /// Creates a new scroll manager instance.
diff --git a/Sources/ScrollKit/Helpers/ScrollViewOffsetTracker.swift b/Sources/ScrollKit/Helpers/ScrollViewOffsetTracker.swift
@@ -8,11 +8,11 @@
 
 import SwiftUI
 
-/// This view can wrap any `ScrollView` or `List` content to
-/// get offset tracking working when the view is scrolled.
+/// This view can be used as to the content view of a `ScrollView` or a `List`
+/// to be able to get the scroll offset as the view is scrolled.
 ///
-/// To use this view, add it within a `ScrollView` or `List`,
-/// then apply ``SwiftUI/View/scrollViewOffsetTracking(action:)``
+/// To use this view, just add it as the main content view in a `ScrollView` or a
+/// `List`, then apply ``SwiftUI/View/scrollViewOffsetTracking(action:)``
 /// to the parent view, like this:
 ///
 /// ```swift
@@ -29,8 +29,7 @@ import SwiftUI
 /// }
 /// ```
 ///
-/// The offset action will trigger when the list scrolls and
-/// provide you with the scroll offset.
+/// The offset action will be called with the scroll offset whenever the view scrolls.
 public struct ScrollViewOffsetTracker<Content: View>: View {
     
     public init(
@@ -59,9 +58,8 @@ public struct ScrollViewOffsetTracker<Content: View>: View {
 
 public extension View {
 
-    /// Add this modifier to a `ScrollView`, a `List` or any
-    /// view that has a ``ScrollViewOffsetTracker`` to track
-    /// its scroll offset.
+    /// Add this modifier to a `ScrollView`, a `List` or any view that has a
+    /// ``ScrollViewOffsetTracker`` to track its scroll offset.
     func scrollViewOffsetTracking(
         action: @escaping @MainActor @Sendable (_ offset: CGPoint) -> Void
     ) -> some View {
diff --git a/Sources/ScrollKit/ScrollViewHeader.swift b/Sources/ScrollKit/ScrollViewHeader.swift
@@ -8,11 +8,11 @@
 
 import SwiftUI
 
-/// This view can be used as a scroll view header, that will
-/// automatically stretch its content when pulled down.
+/// This view can be used as a scroll view header, and will automatically stretch its
+/// content when pulled down.
 ///
-/// For instance, this creates a header view with a gradient
-/// background, a gradient overlay and a bottom-leading text:
+/// For instance, this would create a scroll view header with a gradient background,
+/// a gradient overlay and a bottom-leading text:
 ///
 /// ```swift
 /// struct MyHeader: View {
@@ -38,8 +38,8 @@ import SwiftUI
 /// }
 /// ```
 ///
-/// To add the view to a scroll view with more content below
-/// the header, just add the header topmost in a `VStack`:
+/// To add this view to a scroll view with more content below the header view, just
+/// add the header topmost in a `VStack`:
 ///
 /// ```swift
 /// ScrollView(.vertical) {
@@ -50,8 +50,7 @@ import SwiftUI
 /// }
 /// ```
 ///
-/// Your header view will now automatically stretch out when
-/// the scroll view is pulled down.
+/// Your header view will automatically stretch when the scroll view is pulled down.
 public struct ScrollViewHeader<Content: View>: View {
 
     /// Create a stretchable scroll view header.
diff --git a/Sources/ScrollKit/ScrollViewHeaderGradient.swift b/Sources/ScrollKit/ScrollViewHeaderGradient.swift
@@ -8,11 +8,10 @@
 
 import SwiftUI
 
-/// This view can be used as a header view overlay, when the
-/// background may cause the content to be hard to overview.
+/// This view can be used as an additional background to a header view, when the
+/// original background may cause the content to be hard to overview.
 ///
-/// This is basically just a convenience, to avoid having to
-/// use a `LinearGradient` from scratch.
+/// This is a convenience, to avoid creating a `LinearGradient` from scratch.
 public struct ScrollViewHeaderGradient: View {
 
     /// Create a scroll view header gradient.
diff --git a/Sources/ScrollKit/ScrollViewHeaderImage.swift b/Sources/ScrollKit/ScrollViewHeaderImage.swift
@@ -8,11 +8,9 @@
 
 import SwiftUI
 
-/// This view takes any image and adjusts it to be presented
-/// as a scroll view header.
+/// This view takes any image and adjusts it to be used as a scroll view header.
 ///
-/// This view makes sure that your image stretches correctly
-/// and that it clips to the available space.
+/// The view will automatically stretch correctly and clip to the available space.
 public struct ScrollViewHeaderImage: View {
 
     /// Create a scroll view header image.
diff --git a/Sources/ScrollKit/ScrollViewWithOffsetTracking.swift b/Sources/ScrollKit/ScrollViewWithOffsetTracking.swift
@@ -8,11 +8,10 @@
 
 import SwiftUI
 
-/// This view wraps a native scroll view, and will track its
-/// scroll offset as it's scrolled.
+/// This view wraps a native scroll view and track its scroll offset as it's scrolled.
 ///
-/// You can use the `onScroll` init parameter to pass in any
-/// function that should be called whenever the view scrolls.
+/// You can use the `onScroll` init parameter to pass in a function that should
+/// be called whenever the view scrolls.
 public struct ScrollViewWithOffsetTracking<Content: View>: View {
 
     /// Create a scroll view with offset tracking.
diff --git a/Sources/ScrollKit/ScrollViewWithStickyHeader.swift b/Sources/ScrollKit/ScrollViewWithStickyHeader.swift
@@ -8,41 +8,37 @@
 
 import SwiftUI
 
-/// This scroll view lets you inject a header view that will
-/// stick to the top when the view scrolls.
+/// This scroll view lets you inject a header view that will stick to the top.
 ///
-/// The view wraps a ``ScrollViewWithOffsetTracking`` to get
-/// scroll offset that it then uses to determine how much of
-/// the header that's below the navigation bar. It also uses
-/// a ``ScrollViewHeader`` to make your header view properly
-/// stretch out when the scroll view is pulled down.
+/// This view uses a ``ScrollViewWithOffsetTracking`` to get the scroll
+/// offset, which it then uses to determine how much of the header that's below the
+/// navigation bar.
 ///
-/// You can apply a `headerHeight` which will be the resting
-/// height of the header, a `headerMinHeight` as the minimum
-/// header height (below the top safe area), and an optional
-/// `contentCornerRadius` which applies a corner radius mask
-/// under which the scroll view content will scroll. You can
-/// also set the `headerStretch` parameter to `false` if you
-/// prefer to disable the header stretch effect. This can be
-/// nice when the view is rendered in a sheet, where pulling
-/// down should dismiss the sheet rather than stretching the
-/// sticky header.
+/// This view also uses a ``ScrollViewHeader`` to make any custom header
+/// view properly stretch out when the scroll view is pulled down.
 ///
-/// You can use the `onScroll` init parameter to pass in any
-/// function that should be called whenever the view scrolls.
-/// The function is called with the scroll view offset and a
-/// "header visible ratio", which indicates how much of your
-/// header that is visible below the navigation bar.
+/// You can apply a `headerHeight` which will be used as the resting height of
+/// the header view, a `headerMinHeight` which will be used as the minimum
+/// height below the top safe area, and a `contentCornerRadius` which will
+/// apply a corner radius mask under which the scroll view content will scroll.
 ///
-/// This view will automatically use an inline title display
-/// mode, since it doesn't work for a large nativation title.
+/// You can also set the `headerStretch` parameter to `false` if you prefer
+/// to disable the header stretch effect. This can be nice when the view is rendered
+/// in a sheet, where pulling down should dismiss the sheet rather than stretching
+/// the sticky header.
 ///
-/// > Important: `toolbarBackground(.hidden)` is applied for
-/// iOS 16 and later, to make the navigation bar transparent.
-/// It's not applied on iOS 15 and earlier, which means that
-/// you must use another way to make the bar transparent for
-/// older iOS versions. One way is to use appearance proxies
-/// if you can fall down to UIKit.
+/// You can use `onScroll` to pass in a function that should be called when the
+/// view scrolls. The function will be called with the scroll view offset and a "header
+/// visible ratio", which indicates how much of your header that is visible below the
+/// navigation bar. You can use this ratio to adjust the header content.
+///
+/// This view will automatically apply an inline title display mode, since it does not
+/// work together with a large nativation title.
+///
+/// > Important: `.toolbarBackground(.hidden)` is applied for iOS 16 and
+/// later, to make the navigation bar transparent. For earlier os versions, you must
+/// use another way to make the navigation bar transparent, for instance by using
+/// the UIKit appearance proxies.
 public struct ScrollViewWithStickyHeader<Header: View, Content: View>: View {
 
     /// Create a scroll view with a sticky header.
diff --git a/Sources/ScrollKit/_Deprecated/Spotify.swift b/Sources/ScrollKit/_Deprecated/Spotify.swift
diff --git a/Sources/ScrollKit/_Deprecated/View+Deprecated.swift b/Sources/ScrollKit/_Deprecated/View+Deprecated.swift
