Updates documentation to include the new argument and what it does

apple · Mar 7, 2024 · 8fff1c0 · 8fff1c0
1 parent 4df1014
commit 8fff1c0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/Sources/SwiftDocC/Model/Rendering/Symbol/AvailabilityRenderMetadataItem.swift b/Sources/SwiftDocC/Model/Rendering/Symbol/AvailabilityRenderMetadataItem.swift
@@ -141,6 +141,8 @@ public struct AvailabilityRenderItem: Codable, Hashable, Equatable {
  }
 
  init?(_ availability: Metadata.Availability, current: PlatformVersion?) {
+ // FIXME: Deprecated/Beta markings need platform versions to display properly in Swift-DocC-Render (rdar://56897597)
+
  let platformName = PlatformName(metadataPlatform: availability.platform)
  name = platformName?.displayName
  introduced = availability.introduced

diff --git a/Sources/SwiftDocC/Semantics/Metadata/Availability.swift b/Sources/SwiftDocC/Semantics/Metadata/Availability.swift
@@ -16,10 +16,10 @@ extension Metadata {
  ///
  /// `@Available` is analogous to the `@available` attribute in Swift: It allows you to specify a
  /// platform version that the page relates to. To specify a platform and version, list the platform
- /// name and use the `introduced` argument:
+ /// name and use the `introduced` or `deprecated` arguments:
  ///
  /// ```markdown
- /// @Available(macOS, introduced: "12.0")
+ /// @Available(macOS, introduced: "12.0", deprecated: "14.0")
  /// ```
  ///
  /// Any text can be given to the first argument, and will be displayed in the page's
@@ -88,11 +88,11 @@ extension Metadata {
  @DirectiveArgumentWrapped(name: .unnamed)
  public var platform: Platform
 
- /// The platform version that this page applies to.
+ /// The platform version that this page was introduced in..
  @DirectiveArgumentWrapped
  public var introduced: String? = nil
 
- /// The platform version that this page applies to.
+ /// The platform version that this page was deprecated in.
  @DirectiveArgumentWrapped
  public var deprecated: String? = nil