DocumentationExtension

Defines whether the content in a documentation extension file amends or replaces in-source documentation.

final class DocumentationExtension

Discussion

By default, content from the documentation-extension file is added after the content from the in-source documentation for that symbol.

You get this default behavior in two cases:

when the documentation-extension file doesn’t have a DocumentationExtension directive
when the DocumentationExtension directive explicitly specifies the DocumentationExtension.Behavior.append behavior

The other merge behavior completely replaces the content from the in-source documentation for that symbol with the content from the documentation-extension file. To get this behavior, specify DocumentationExtension.Behavior.override as the merge behavior.

@Metadata {
   @DocumentationExtension(mergeBehavior: override)
}

The DocumentationExtension is only valid within a Metadata directive.

Topics

Instance Properties

Type Properties

static let introducedVersion: String

Enumerations

enum Behavior
The merge behavior in a documentation extension.