Skip to content

Commit 0fc804c

Browse files
committed
fixup! Support @DeprecationSummary in doc comments
1 parent 987a0d5 commit 0fc804c

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

Sources/SwiftDocC/Semantics/Symbol/DeprecationSummary.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ import Markdown
2626
///
2727
/// You can use the `@DeprecationSummary` directive top-level in articles, documentation extension files, or documentation comments.
2828
///
29+
/// > Earlier versions: Before Swift-DocC 6.1, `@DeprecationSummary` was not supported in documentation comments.
30+
///
2931
/// > Tip:
3032
/// > If you are writing a custom deprecation summary message for an API or documentation page that isn't already deprecated,
3133
/// > 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.

Sources/docc/DocCDocumentation.docc/DocC.symbols.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2038,6 +2038,12 @@
20382038
{
20392039
"text" : ""
20402040
},
2041+
{
2042+
"text" : "> Earlier versions: Before Swift-DocC 6.1, `@DeprecationSummary` was not supported in documentation comments."
2043+
},
2044+
{
2045+
"text" : ""
2046+
},
20412047
{
20422048
"text" : "> Tip:"
20432049
},

0 commit comments

Comments
 (0)