Skip to content

Commit 26ac7e3

Browse files
committed
fixup! Allow @Metadata directives in doc comments
1 parent b32dadd commit 26ac7e3

File tree

1 file changed

+4
-4
lines changed
  • Sources/docc/DocCDocumentation.docc/Reference Syntax/API Reference Syntax

1 file changed

+4
-4
lines changed

Sources/docc/DocCDocumentation.docc/Reference Syntax/API Reference Syntax/Metadata.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,15 @@ previous versions, @Redirected must be used as a top level directive.
5858

5959
### Usage in documentation comments
6060

61-
You can specify `@Metadata` configuration in documentation comments for the following customizations:
62-
63-
- ``Available``
64-
- ``CustomMetadata``
61+
You can specify `@Metadata` configuration in documentation comments to specify ``Available`` directives. Other metadata directives are
62+
not supported in documentation comments.
6563

6664
> Note: Don't specify an `@Metadata` directive in both the symbol's documentation comment and its documentation extension file.
6765
If you have one in each, DocC will pick the one in the documentation extension and discard the one in the documentation
6866
comment.
6967

68+
> Earlier versions: Before Swift-DocC 6.1, `@Metadata` was not supported in documentation comments.
69+
7070
## Topics
7171

7272
### Extending or Overriding Source Documentation

0 commit comments

Comments
 (0)