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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
# ``docc/DisplayName``
Configures a symbol's documentation page and any references to that page to show a custom name instead of the symbol name.
@Metadata {
@DocumentationExtension(mergeBehavior: override)
}
- Parameters:
- name: The custom display name.
- style: The text style used to format the symbol's display name. A value of `conceptual` (the default) denotes a plain text style that's not monospaced. A value of `symbol` denotes a monospaced text style. **(optional)**
## Overview
Place the `DisplayName` directive within a `Metadata` directive to configure a symbol's documentation page and any references to that page to show a custom name.
```
# ``SlothCreator``
@Metadata {
@DisplayName("Sloth Creator")
}
```
A custom display name appears in place of the symbol's name in the following locations:
- The main header on the symbol page
- The navigator hierarchy
- Breadcrumbs for the symbol page and its child symbol pages
- Link text anywhere that includes a link to the symbol page
> Note: Customizing the name of a symbol page doesn't alter the page's URL.
By default, a custom display name renders without a monospaced text style. To retain the monospaced text style that's typically used when referencing APIs, specify a value of `symbol` for the optional `style` parameter:
```
# ``SlothCreator``
@Metadata {
@DisplayName("Sloth Creator", style: symbol)
}
```
> Note: Adding a `DisplayName` directive to a non-symbol page results in a warning.
### Containing Elements
The following items can include a display name element:
- ``Metadata``
<!-- Copyright (c) 2022 Apple Inc and the Swift Project authors. All Rights Reserved. -->
|
