From 0fc804cba0a1ed417c87ae21a704deefdbfabd97 Mon Sep 17 00:00:00 2001 From: Franklin Schrans Date: Tue, 10 Dec 2024 14:04:26 +0000 Subject: [PATCH] fixup! Support `@DeprecationSummary` in doc comments --- Sources/SwiftDocC/Semantics/Symbol/DeprecationSummary.swift | 2 ++ Sources/docc/DocCDocumentation.docc/DocC.symbols.json | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/Sources/SwiftDocC/Semantics/Symbol/DeprecationSummary.swift b/Sources/SwiftDocC/Semantics/Symbol/DeprecationSummary.swift index a95a122b7..ca44f7571 100644 --- a/Sources/SwiftDocC/Semantics/Symbol/DeprecationSummary.swift +++ b/Sources/SwiftDocC/Semantics/Symbol/DeprecationSummary.swift @@ -26,6 +26,8 @@ import Markdown /// /// You can use the `@DeprecationSummary` directive top-level in articles, documentation extension files, or documentation comments. /// +/// > Earlier versions: Before Swift-DocC 6.1, `@DeprecationSummary` was not supported in documentation comments. +/// /// > Tip: /// > If you are writing a custom deprecation summary message for an API or documentation page that isn't already deprecated, /// > you should also deprecate it—using in-source annotations when possible or ``Available`` directives when in-source annotations aren't available—so that the reader knows the version when you deprecated that API or documentation page. diff --git a/Sources/docc/DocCDocumentation.docc/DocC.symbols.json b/Sources/docc/DocCDocumentation.docc/DocC.symbols.json index fb71c479c..75b7a14bf 100644 --- a/Sources/docc/DocCDocumentation.docc/DocC.symbols.json +++ b/Sources/docc/DocCDocumentation.docc/DocC.symbols.json @@ -2038,6 +2038,12 @@ { "text" : "" }, + { + "text" : "> Earlier versions: Before Swift-DocC 6.1, `@DeprecationSummary` was not supported in documentation comments." + }, + { + "text" : "" + }, { "text" : "> Tip:" },