Remove API that was deprecated during the 5.9 release (#860)

d-ronnqvist · web-flow · commit 3e0c8e2d71ea · 2024-03-19T09:35:46.000+01:00
* Remove API that was deprecated during the 5.9 release

* Update version information for when deprecated API will be removed

The release after 5.10 is not 5.11 but 6.0.
The API said 5.12 in their deprecation message was really deprecated during the 5.10 release and should have said 5.11 as the version the API will be removed.
diff --git a/Sources/SwiftDocC/Indexing/Navigator/NavigatorIndex.swift b/Sources/SwiftDocC/Indexing/Navigator/NavigatorIndex.swift
@@ -65,7 +65,7 @@ public class NavigatorIndex {
         /// Missing bundle identifier.
         case missingBundleIdentifier
         
-        @available(*, deprecated, renamed: "missingBundleIdentifier", message: "Use 'missingBundleIdentifier' instead. This deprecated API will be removed after 5.11 is released")
+        @available(*, deprecated, renamed: "missingBundleIdentifier", message: "Use 'missingBundleIdentifier' instead. This deprecated API will be removed after 6.0 is released")
         case missingBundleIndentifier
         
         /// A RenderNode has no title and won't be indexed.
diff --git a/Sources/SwiftDocC/Infrastructure/Diagnostics/Diagnostic.swift b/Sources/SwiftDocC/Infrastructure/Diagnostics/Diagnostic.swift
@@ -33,18 +33,8 @@ public struct Diagnostic {
     /// A brief summary that describe the problem or issue.
     public var summary: String
     
-    @available(*, deprecated, renamed: "summary", message: "Use 'summary' instead. This deprecated API will be removed after 5.10 is released")
-    public var localizedSummary: String {
-        return summary
-    }
-
     /// Additional details that explain the problem or issue to the end-user in plain language.
     public var explanation: String?
-    
-    @available(*, deprecated, renamed: "explanation", message: "Use 'explanation' instead. This deprecated API will be removed after 5.10 is released")
-    public var localizedExplanation: String? {
-        return explanation
-    }
 
     /// Extra notes to tack onto the editor for additional information.
     ///
@@ -82,18 +72,3 @@ public extension Diagnostic {
         
     }
 }
-
-// MARK: Deprecated
-
-@available(*, deprecated, message: "Use 'DiagnosticConsoleWriter.formattedDescription(for:options:)' instead. This deprecated API will be removed after 5.10 is released")
-extension Diagnostic: DescribedError {
-    @available(*, deprecated, message: "Use 'DiagnosticConsoleWriter.formattedDescription(for:options:)' instead. This deprecated API will be removed after 5.10 is released")
-    var localizedDescription: String {
-        return DiagnosticConsoleWriter.formattedDescription(for: self)
-    }
-
-    @available(*, deprecated, message: "Use 'DiagnosticConsoleWriter.formattedDescription(for:options:)' instead. This deprecated API will be removed after 5.10 is released")
-    public var errorDescription: String {
-        return DiagnosticConsoleWriter.formattedDescription(for: self)
-    }
-}
diff --git a/Sources/SwiftDocC/Infrastructure/Diagnostics/DiagnosticConsoleWriter.swift b/Sources/SwiftDocC/Infrastructure/Diagnostics/DiagnosticConsoleWriter.swift
@@ -76,7 +76,7 @@ public final class DiagnosticConsoleWriter: DiagnosticFormattingConsumer {
     }
     
     // This is deprecated but still necessary to implement.
-    @available(*, deprecated, renamed: "flush()", message: "Use 'flush()' instead. This deprecated API will be removed after 5.11 is released")
+    @available(*, deprecated, renamed: "flush()", message: "Use 'flush()' instead. This deprecated API will be removed after 6.0 is released")
     public func finalize() throws {
         try flush()
     }
diff --git a/Sources/SwiftDocC/Infrastructure/Diagnostics/DiagnosticConsumer.swift b/Sources/SwiftDocC/Infrastructure/Diagnostics/DiagnosticConsumer.swift
@@ -17,7 +17,7 @@ public protocol DiagnosticConsumer: AnyObject {
     func receive(_ problems: [Problem])
     
     /// Inform the consumer that the engine has sent all diagnostics for this build.
-    @available(*, deprecated, renamed: "flush()", message: "Use 'flush()' instead. This deprecated API will be removed after 5.11 is released")
+    @available(*, deprecated, renamed: "flush()", message: "Use 'flush()' instead. This deprecated API will be removed after 6.0 is released")
     func finalize() throws
     
     /// Inform the consumer that the engine has sent all diagnostics in a given context.
@@ -32,7 +32,7 @@ public protocol DiagnosticFormattingConsumer: DiagnosticConsumer {
 
 public extension DiagnosticConsumer {
     // Deprecated for suppressing the warning emitted when calling `finalize()`
-    @available(*, deprecated, message: "This deprecated API will be removed after 5.11 is released")
+    @available(*, deprecated, message: "This deprecated API will be removed after 6.0 is released")
     func flush() throws {
         try finalize()
     }
diff --git a/Sources/SwiftDocC/Infrastructure/Diagnostics/DiagnosticEngine.swift b/Sources/SwiftDocC/Infrastructure/Diagnostics/DiagnosticEngine.swift
@@ -105,7 +105,7 @@ public final class DiagnosticEngine {
         }
     }
     
-    @available(*, deprecated, renamed: "flush()", message: "Use 'flush()' instead. This deprecated API will be removed after 5.11 is released")
+    @available(*, deprecated, renamed: "flush()", message: "Use 'flush()' instead. This deprecated API will be removed after 6.0 is released")
     public func finalize() {
         flush()
     }
diff --git a/Sources/SwiftDocC/Infrastructure/Diagnostics/DiagnosticFormattingOptions.swift b/Sources/SwiftDocC/Infrastructure/Diagnostics/DiagnosticFormattingOptions.swift
@@ -16,10 +16,6 @@ public struct DiagnosticFormattingOptions: OptionSet {
         self.rawValue = rawValue
     }
 
-    /// Problem fix-its should be included when printing diagnostics to a file or output stream.
-    @available(*, deprecated, renamed: "formatConsoleOutputForTools" , message: "Use 'formatConsoleOutputForTools' instead. This deprecated API will be removed after 5.10 is released")
-    public static let showFixits = formatConsoleOutputForTools
-
     /// Output to the console should be formatted for an IDE or other tool to parse.
     public static let formatConsoleOutputForTools = DiagnosticFormattingOptions(rawValue: 1 << 0)
 
diff --git a/Sources/SwiftDocC/Infrastructure/Diagnostics/DiagnosticNote.swift b/Sources/SwiftDocC/Infrastructure/Diagnostics/DiagnosticNote.swift
@@ -24,12 +24,3 @@ public struct DiagnosticNote {
     /// The message to attach to the document.
     public var message: String
 }
-
-@available(*, deprecated, message: "Use 'DiagnosticConsoleWriter.formattedDescription(for:options:)' instead. This deprecated API will be removed after 5.10 is released")
-extension DiagnosticNote: CustomStringConvertible {
-    @available(*, deprecated, message: "Use 'DiagnosticConsoleWriter.formattedDescription(for:options:)' instead. This deprecated API will be removed after 5.10 is released")
-    public var description: String {
-        let location = "\(source.path):\(range.lowerBound.line):\(range.lowerBound.column)"
-        return "\(location): note: \(message)"
-    }
-}
diff --git a/Sources/SwiftDocC/Infrastructure/Diagnostics/Problem.swift b/Sources/SwiftDocC/Infrastructure/Diagnostics/Problem.swift
@@ -52,29 +52,3 @@ extension Sequence where Element == Problem {
         }
     }
 }
-
-// MARK: Deprecated
-
-extension Problem {
-    @available(*, deprecated, message: "Use 'DiagnosticConsoleWriter.formattedDescription(for:options:)' instead. This deprecated API will be removed after 5.10 is released")
-    var localizedDescription: String {
-        return DiagnosticConsoleWriter.formattedDescription(for: self)
-    }
-
-    @available(*, deprecated, message: "Use 'DiagnosticConsoleWriter.formattedDescription(for:options:)' instead. This deprecated API will be removed after 5.10 is released")
-    func formattedLocalizedDescription(withOptions options: DiagnosticFormattingOptions = []) -> String {
-        return DiagnosticConsoleWriter.formattedDescription(for: self, options: options)
-    }
-}
-
-extension Sequence where Element == Problem {
-    @available(*, deprecated, message: "Use 'DiagnosticConsoleWriter.formattedDescription(for:options:)' instead. This deprecated API will be removed after 5.10 is released")
-    public var localizedDescription: String {
-        return map { $0.localizedDescription }.joined(separator: "\n")
-    }
-
-    @available(*, deprecated, message: "Use 'DiagnosticConsoleWriter.formattedDescription(for:options:)' instead. This deprecated API will be removed after 5.10 is released")
-    public func formattedLocalizedDescription(withOptions options: DiagnosticFormattingOptions) -> String {
-        return map { $0.formattedLocalizedDescription(withOptions: options) }.joined(separator: "\n")
-    }
-}
diff --git a/Sources/SwiftDocC/Infrastructure/External Data/Deprecated/DocumentationContext+DeprecatedResolvers.swift b/Sources/SwiftDocC/Infrastructure/External Data/Deprecated/DocumentationContext+DeprecatedResolvers.swift
@@ -11,31 +11,31 @@
 import Foundation
 
 extension DocumentationContext {
-    @available(*, deprecated, message: "This deprecated API will be removed after 5.11 is released")
+    @available(*, deprecated, message: "This deprecated API will be removed after 6.0 is released")
     public var _externalAssetResolvers: [BundleIdentifier: _ExternalAssetResolver] {
         get { [:] }
         set { /* do nothing */ }
     }
     
-    @available(*, deprecated, renamed: "globalExternalSymbolResolver", message: "Use 'globalExternalSymbolResolver' instead. This deprecated API will be removed after 5.11 is released")
+    @available(*, deprecated, renamed: "globalExternalSymbolResolver", message: "Use 'globalExternalSymbolResolver' instead. This deprecated API will be removed after 6.0 is released")
     public var externalSymbolResolver: ExternalSymbolResolver? {
         get { nil }
         set { /* do nothing */ }
     }
     
-    @available(*, deprecated, renamed: "externalDocumentationSources", message: "Use 'externalDocumentationSources' instead. This deprecated API will be removed after 5.11 is released")
+    @available(*, deprecated, renamed: "externalDocumentationSources", message: "Use 'externalDocumentationSources' instead. This deprecated API will be removed after 6.0 is released")
     public var externalReferenceResolvers: [BundleIdentifier: ExternalReferenceResolver] {
         get { [:] }
         set { /* do nothing */ }
     }
     
-    @available(*, deprecated, renamed: "convertServiceFallbackResolver", message: "Use 'convertServiceFallbackResolver' instead. This deprecated API will be removed after 5.11 is released")
+    @available(*, deprecated, renamed: "convertServiceFallbackResolver", message: "Use 'convertServiceFallbackResolver' instead. This deprecated API will be removed after 6.0 is released")
     public var fallbackReferenceResolvers: [BundleIdentifier: FallbackReferenceResolver] {
         get { [:] }
         set { /* do nothing */ }
     }
     
-    @available(*, deprecated, renamed: "convertServiceFallbackResolver", message: "Use 'convertServiceFallbackResolver' instead. This deprecated API will be removed after 5.11 is released")
+    @available(*, deprecated, renamed: "convertServiceFallbackResolver", message: "Use 'convertServiceFallbackResolver' instead. This deprecated API will be removed after 6.0 is released")
     public var fallbackAssetResolvers: [BundleIdentifier: FallbackAssetResolver] {
         get { [:] }
         set { /* do nothing */ }
diff --git a/Sources/SwiftDocC/Infrastructure/External Data/Deprecated/OutOfProcessReferenceResolver+DeprecatedResolvers.swift b/Sources/SwiftDocC/Infrastructure/External Data/Deprecated/OutOfProcessReferenceResolver+DeprecatedResolvers.swift
@@ -23,7 +23,7 @@ private struct DeprecatedAPIError: DescribedError {
 
 // MARK: External Symbol Resolver
 
-@available(*, deprecated, renamed: "GlobalExternalSymbolResolver", message: "Use 'GlobalExternalSymbolResolver' instead. This deprecated API will be removed after 5.11 is released")
+@available(*, deprecated, renamed: "GlobalExternalSymbolResolver", message: "Use 'GlobalExternalSymbolResolver' instead. This deprecated API will be removed after 6.0 is released")
 public protocol ExternalSymbolResolver {
     func symbolEntity(withPreciseIdentifier preciseIdentifier: String) throws -> DocumentationNode
     func urlForResolvedSymbol(reference: ResolvedTopicReference) -> URL?
@@ -49,7 +49,7 @@ extension OutOfProcessReferenceResolver: ExternalSymbolResolver {
 
 // MARK: External Reference Resolver
 
-@available(*, deprecated, renamed: "ExternalDocumentationSource", message: "Use 'ExternalDocumentationSource' instead. This deprecated API will be removed after 5.11 is released")
+@available(*, deprecated, renamed: "ExternalDocumentationSource", message: "Use 'ExternalDocumentationSource' instead. This deprecated API will be removed after 6.0 is released")
 public protocol ExternalReferenceResolver {
     func resolve(_ reference: TopicReference, sourceLanguage: SourceLanguage) -> TopicReferenceResolutionResult
     func entity(with reference: ResolvedTopicReference) throws -> DocumentationNode
@@ -75,7 +75,7 @@ extension OutOfProcessReferenceResolver: ExternalReferenceResolver {
 
 // MARK: Fallback Reference Resolver
 
-@available(*, deprecated, renamed: "ConvertServiceFallbackResolver", message: "Use 'ConvertServiceFallbackResolver' instead. This deprecated API will be removed after 5.11 is released")
+@available(*, deprecated, renamed: "ConvertServiceFallbackResolver", message: "Use 'ConvertServiceFallbackResolver' instead. This deprecated API will be removed after 6.0 is released")
 public protocol FallbackReferenceResolver {
     func resolve(_ reference: TopicReference, sourceLanguage: SourceLanguage) -> TopicReferenceResolutionResult
     func entityIfPreviouslyResolved(with reference: ResolvedTopicReference) throws -> DocumentationNode?
@@ -97,7 +97,7 @@ extension OutOfProcessReferenceResolver: FallbackReferenceResolver {
 
 // MARK: Fallback Asset Resolver
 
-@available(*, deprecated, renamed: "ConvertServiceFallbackResolver", message: "Use 'ConvertServiceFallbackResolver' instead. This deprecated API will be removed after 5.11 is released")
+@available(*, deprecated, renamed: "ConvertServiceFallbackResolver", message: "Use 'ConvertServiceFallbackResolver' instead. This deprecated API will be removed after 6.0 is released")
 public protocol FallbackAssetResolver {
     func resolve(assetNamed assetName: String, bundleIdentifier: String) -> DataAsset?
 }
@@ -112,7 +112,7 @@ extension OutOfProcessReferenceResolver: FallbackAssetResolver {
 
 // MARK: External Asset Resolver
 
-@available(*, deprecated, message: "This protocol is not used. This deprecated API will be removed after 5.11 is released")
+@available(*, deprecated, message: "This protocol is not used. This deprecated API will be removed after 6.0 is released")
 public protocol _ExternalAssetResolver {
     func _resolveExternalAsset(named assetName: String, bundleIdentifier: String) -> DataAsset?
 }
diff --git a/Sources/SwiftDocC/Infrastructure/Workspace/DefaultAvailability.swift b/Sources/SwiftDocC/Infrastructure/Workspace/DefaultAvailability.swift
@@ -61,7 +61,7 @@ public struct DefaultAvailability: Codable, Equatable {
         internal var versionInformation: VersionInformation
 
         /// A string representation of the version for this platform.
-        @available(*, deprecated, message: "Use `introducedVersion` instead.  This deprecated API will be removed after 5.11 is released", renamed: "introducedVersion")
+        @available(*, deprecated, message: "Use `introducedVersion` instead.  This deprecated API will be removed after 6.0 is released", renamed: "introducedVersion")
         public var platformVersion: String {
             return introducedVersion ?? "0.0"
         }
diff --git a/Sources/SwiftDocC/Model/Rendering/References/ExternalLocationReference.swift b/Sources/SwiftDocC/Model/Rendering/References/ExternalLocationReference.swift
diff --git a/Sources/SwiftDocC/Model/Rendering/Variants/RenderNodeVariantOverridesApplier.swift b/Sources/SwiftDocC/Model/Rendering/Variants/RenderNodeVariantOverridesApplier.swift
@@ -43,7 +43,7 @@ public struct RenderNodeVariantOverridesApplier {
         var variantOverrides: VariantOverrides?
     }
     
-    @available(*, deprecated, message: "This error is never raised. This deprecated API will be removed after 5.11 is released")
+    @available(*, deprecated, message: "This error is never raised. This deprecated API will be removed after 6.0 is released")
     public enum Error: DescribedError {
         case corruptedRenderNode
         public var errorDescription: String {
diff --git a/Sources/SwiftDocC/Semantics/Metadata/CallToAction.swift b/Sources/SwiftDocC/Semantics/Metadata/CallToAction.swift
@@ -80,13 +80,6 @@ public final class CallToAction: Semantic, AutomaticDirectiveConvertible {
         "purpose"  : \CallToAction._purpose,
         "label"    : \CallToAction._label,
     ]
-
-    /// The computed label for this Call to Action, whether provided directly via ``label`` or
-    /// indirectly via ``purpose``.
-    @available(*, deprecated, renamed: "buttonLabel(for:)", message: "Use 'buttonLabel(for:)' instead. This deprecated API will be removed after 5.10 is released")
-    public var buttonLabel: String {
-        return buttonLabel(for: nil)
-    }
     
     /// The label that should be used when rendering the user-interface for this call to action button.
     ///
@@ -189,13 +182,6 @@ extension CallToAction {
 }
 
 extension CallToAction.Purpose {
-    /// The label that will be applied to a Call to Action with this purpose if it doesn't provide
-    /// a separate label.
-    @available(*, deprecated, message: "Use 'CallToAction.buttonLabel(for:)' instead. This deprecated API will be removed after 5.10 is released")
-    public var defaultLabel: String {
-        return defaultLabel(for: nil)
-    }
-    
     fileprivate func defaultLabel(for pageKind: Metadata.PageKind.Kind?) -> String {
         switch self {
         case .download:
diff --git a/Sources/SwiftDocC/Semantics/Symbol/Symbol.swift b/Sources/SwiftDocC/Semantics/Symbol/Symbol.swift
@@ -556,7 +556,7 @@ extension Symbol {
     public var platformName: PlatformName? { platformNameVariants.firstValue }
     
     /// The first variant of the symbol's extended module, if available
-    @available(*, deprecated, message: "Use 'extendedModuleVariants' instead. This deprecated API will be removed after 5.12 is released")
+    @available(*, deprecated, message: "Use 'extendedModuleVariants' instead. This deprecated API will be removed after 6.0 is released")
     public var extendedModule: String? { extendedModuleVariants.firstValue }
 
     /// Whether the first variant of the symbol is required in its context.
diff --git a/Sources/SwiftDocC/Utility/FeatureFlags.swift b/Sources/SwiftDocC/Utility/FeatureFlags.swift
@@ -17,10 +17,6 @@ public struct FeatureFlags: Codable {
     /// Whether or not experimental support for device frames on images and video is enabled.
     public var isExperimentalDeviceFrameSupportEnabled = false
 
-    /// Whether or not experimental support for parsing Doxygen commands is enabled.
-    @available(*, deprecated, message: "Doxygen support is now enabled by default. This deprecated API will be removed after 5.10 is released")
-    public var isExperimentalDoxygenSupportEnabled = false
-    
     /// Whether or not experimental support for emitting a serialized version of the local link resolution information is enabled.
     public var isExperimentalLinkHierarchySerializationEnabled = false
     
diff --git a/Sources/SwiftDocCUtilities/Action/Actions/Convert/ConvertAction.swift b/Sources/SwiftDocCUtilities/Action/Actions/Convert/ConvertAction.swift
diff --git a/Sources/SwiftDocCUtilities/ArgumentParsing/Options/DocumentationBundleOption.swift b/Sources/SwiftDocCUtilities/ArgumentParsing/Options/DocumentationBundleOption.swift
diff --git a/Sources/SwiftDocCUtilities/ArgumentParsing/Options/DocumentationCoverageOptionsArgument.swift b/Sources/SwiftDocCUtilities/ArgumentParsing/Options/DocumentationCoverageOptionsArgument.swift
diff --git a/Sources/SwiftDocCUtilities/ArgumentParsing/Subcommands/Convert.swift b/Sources/SwiftDocCUtilities/ArgumentParsing/Subcommands/Convert.swift

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ public final class DiagnosticConsoleWriter: DiagnosticFormattingConsumer {`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`// This is deprecated but still necessary to implement.`
`79`		`- @available(*, deprecated, renamed: "flush()", message: "Use 'flush()' instead. This deprecated API will be removed after 5.11 is released")`
	`79`	`+ @available(*, deprecated, renamed: "flush()", message: "Use 'flush()' instead. This deprecated API will be removed after 6.0 is released")`
`80`	`80`	`public func finalize() throws {`
`81`	`81`	`try flush()`
`82`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ public final class DiagnosticEngine {`
`105`	`105`	`}`
`106`	`106`	`}`
`107`	`107`
`108`		`- @available(*, deprecated, renamed: "flush()", message: "Use 'flush()' instead. This deprecated API will be removed after 5.11 is released")`
	`108`	`+ @available(*, deprecated, renamed: "flush()", message: "Use 'flush()' instead. This deprecated API will be removed after 6.0 is released")`
`109`	`109`	`public func finalize() {`
`110`	`110`	`flush()`
`111`	`111`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,10 +16,6 @@ public struct DiagnosticFormattingOptions: OptionSet {`
`16`	`16`	`self.rawValue = rawValue`
`17`	`17`	`}`
`18`	`18`
`19`		`- /// Problem fix-its should be included when printing diagnostics to a file or output stream.`
`20`		`- @available(*, deprecated, renamed: "formatConsoleOutputForTools" , message: "Use 'formatConsoleOutputForTools' instead. This deprecated API will be removed after 5.10 is released")`
`21`		`- public static let showFixits = formatConsoleOutputForTools`
`22`		`-`
`23`	`19`	`/// Output to the console should be formatted for an IDE or other tool to parse.`
`24`	`20`	`public static let formatConsoleOutputForTools = DiagnosticFormattingOptions(rawValue: 1 << 0)`
`25`	`21`