---
title: DeprecationSummary
framework: docc
role: symbol
role_heading: Directive
path: docc/deprecationsummary
---

# DeprecationSummary

A directive that specifies a custom deprecation summary message to an already deprecated symbol.

## Declaration

```swift
@DeprecationSummary {
    ...
}
```

## Overview

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. note: Before Swift-DocC 6.1, @DeprecationSummary was not supported in documentation comments. tip: If you are writing a custom deprecation summary message for an API or documentation page that isn’t already deprecated, 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.

## See Also

### Customizing the Availability Information of a Page

- [Available](docc/available.md)