Standardize reserved property documentation

Author: swift-developer-tools-archive

Sources/SwiftLibgit2/Blame/Blame-Enums.swift

@@ -53,16 +53,16 @@ public struct GitBlameFlagT: COptionSet
     ///
     /// This is the equivalent of `git blame -M`.
     ///
-    /// - Note: This has not yet been implemented, but is reserved for
-    /// future use.
+    /// - Note: This has not been implemented in libgit2 yet, but is reserved
+    /// for future use.
     public static let gitBlameTrackCopiesSameFile           = GitBlameFlagT(rawValue: GIT_BLAME_TRACK_COPIES_SAME_FILE.rawValue)
 
     /// Track lines that have moved across files in the same commit.
     ///
     /// This is the equivalent of `git blame -C`.
     ///
-    /// - Note: This has not yet been implemented, but is reserved for
-    /// future use.
+    /// - Note: This has not been implemented in libgit2 yet, but is reserved
+    /// for future use.
     public static let gitBlameTrackCopiesSameCommitMoves    = GitBlameFlagT(rawValue: GIT_BLAME_TRACK_COPIES_SAME_COMMIT_MOVES.rawValue)
 
     /// Track lines that have been copied from another file that exists in the
@@ -71,8 +71,8 @@ public struct GitBlameFlagT: COptionSet
     /// This is the equivalent of `git blame -CC`, and implies
     /// ``gitBlameTrackCopiesSameFile``.
     ///
-    /// - Note: This has not yet been implemented, but is reserved for
-    /// future use.
+    /// - Note: This has not been implemented in libgit2 yet, but is reserved
+    /// for future use.
     public static let gitBlameTrackCopiesSameCommitCopies   = GitBlameFlagT(rawValue: GIT_BLAME_TRACK_COPIES_SAME_COMMIT_COPIES.rawValue)
 
     /// Track lines that have been copied from another file that exists in
@@ -81,8 +81,8 @@ public struct GitBlameFlagT: COptionSet
     /// This is the equivalent of `git blame -CCC`, and implies
     /// ``gitBlameTrackCopiesSameCommitCopies``.
     ///
-    /// - Note: This has not yet been implemented, but is reserved for
-    /// future use.
+    /// - Note: This has not been implemented in libgit2 yet, but is reserved
+    /// for future use.
     public static let gitBlameTrackCopiesAnyCommitCopies    = GitBlameFlagT(rawValue: GIT_BLAME_TRACK_COPIES_ANY_COMMIT_COPIES.rawValue)
 
     /// Restrict the search of commits to those reachable by following only

Sources/SwiftLibgit2/Blob/Blob-Structs.swift

@@ -33,7 +33,8 @@ public struct GitBlobFilterOptions: CStructMutable, WithCConvertible, Sendable
     ///
     /// The default value is `nil`.
     ///
-    /// - Note: This property is unused, but is reserved for API compatibility.
+    /// - Note: This property is unused in libgit2, but is reserved for API
+    /// compatibility.
     public var commitID     : GitOID?
 
     /// The commit from which to load attributes when

Sources/SwiftLibgit2/Buffer/Buffer-Structs.swift

@@ -30,7 +30,10 @@ public struct GitBuf: CStruct
     /// contains a null terminator at position `size + 1`.
     public let ptr      : UnsafeMutablePointer<CChar>?
 
-    /// This property is unused, but is reserved for API compatibility.
+    /// A reserved property.
+    ///
+    /// - Note: This property is unused in libgit2, but is reserved for API
+    /// compatibility.
     ///
     /// The default value is `0`.
     public let reserved : Int

Sources/SwiftLibgit2/Checkout/Checkout-Enums.swift

@@ -170,15 +170,15 @@ public struct GitCheckoutStrategyT: COptionSet
 
     /// Recursively checkout submodules with the same options.
     ///
-    /// - Note: This has not yet been implemented, but is reserved for future
-    /// use.
+    /// - Note: This has not been implemented in libgit2 yet, but is reserved
+    /// for future use.
     public static let gitCheckoutUpdateSubmodules           = GitCheckoutStrategyT(rawValue: GIT_CHECKOUT_UPDATE_SUBMODULES.rawValue)
 
     /// Recursively checkout submodules with the same options, if HEAD moved
     /// in the super repository.
     ///
-    /// - Note: This has not yet been implemented, but is reserved for future
-    /// use.
+    /// - Note: This has not been implemented in libgit2 yet, but is reserved
+    /// for future use.
     public static let gitCheckoutUpdateSubmodulesIfChanged  = GitCheckoutStrategyT(rawValue: GIT_CHECKOUT_UPDATE_SUBMODULES_IF_CHANGED.rawValue)
 
 

Sources/SwiftLibgit2/Diff/Diff-Enums.swift

@@ -235,8 +235,8 @@ public struct GitDiffOptionT: COptionSet
 /// ``GitDiffDelta`` and the ``GitDiffFile/flags`` property of ``GitDiffFile``
 /// that represent the old and new sides of the delta.
 ///
-/// Values outside of the public supported range are reserved for internal or
-/// future use.
+/// - Note: Values outside of the public supported range are reserved for
+/// internal or future use.
 ///
 /// ## C Equivalent
 ///

Sources/SwiftLibgit2/Diff/Diff-Structs.swift

@@ -1184,7 +1184,8 @@ public struct GitDiffParseOptions: CStructMutable, CConvertible, Sendable
 
 /// The options for calculating patch IDs.
 ///
-/// - Note: This is reserved for future use. No options are currently available.
+/// - Note: This has not been implemented in libgit2 yet, but is reserved
+/// for future use.
 ///
 /// ## C Equivalent
 ///