DeprecationSummary

Declaration

@DeprecationSummary {
    ...
}

Overview

Many in-source deprecation annotations—such as the @available attribute in Swift—allow you to specify a plain text deprecation message. You can use the @DeprecationSummary directive to override that deprecation message with one or more paragraphs of formatted documentation markup. For example,

@DeprecationSummary {
    This method is unsafe because it could potentially cause buffer overruns.
    Use ``getBytes(_:length:)`` or ``getBytes(_:range:)`` instead.
}

You can use the @DeprecationSummary directive top-level in articles, documentation extension files, or documentation comments.

See Also

Customizing the Availability Information of a Page

• Available