fixup! Support @DeprecationSummary in doc comments

swiftlang · Dec 11, 2024 · 0fc804c · 0fc804c
1 parent 987a0d5
commit 0fc804c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git 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
@@ -2038,6 +2038,12 @@
           {
             "text" : ""
           },
+          {
+            "text" : "> Earlier versions: Before Swift-DocC 6.1, `@DeprecationSummary` was not supported in documentation comments."
+          },
+          {
+            "text" : ""
+          },
           {
             "text" : "> Tip:"
           },