1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
|
# ``DocumentationExtension``
Defines whether the content in a documentation extension file replaces in-source documentation or amends it (the default).
@Metadata {
@DocumentationExtension(mergeBehavior: override)
}
- Parameters:
- mergeBehavior: A value of `override` to replace the in-source documentation with the extension file's content. **(required)**
## Overview
By default, content from the documentation-extension file is added after the content from the in-source documentation for that symbol.
Swift framework and package APIs are typically documented using comments that reside in-source, alongside the APIs themselves. In some cases, you may wish to supplement or replace in-source documentation with content from dedicated documentation extension files. To learn about this process, see <doc:adding-supplemental-content-to-a-documentation-catalog>.
Place the `DocumentationExtension` directive within a `Metadata` directive in a documentation extension file. Set the `mergeBehavior` parameter to `append` or `override` to indicate whether the extension file's content amends or replaces the in-source documentation.
```
@Metadata {
@DocumentationExtension(mergeBehavior: override)
}
```
> Note:
> You can specify a `append` merge behavior but it has the same effect as not defining a `@DocumentationExtension` and results in a warning.
### Containing Elements
The following items can include a documentation extension element:
- ``Metadata``
<!-- Copyright (c) 2021-2024 Apple Inc and the Swift Project authors. All Rights Reserved. -->
|
