Class

DisplayName

A directive that controls how the documentation-extension file overrides the symbol’s display name.

final class DisplayName

Discussion

The name property will override the symbol’s default display name.

When the style property is DisplayName.Style.conceptual, the symbol’s name is rendered as “conceptual”—same as article names or tutorial names—where applicable. The default style is DisplayName.Style.conceptual.

When the style property is DisplayName.Style.symbol, the symbol’s name is rendered as “symbol”—same as article names or tutorial names—where applicable. The default style is DisplayName.Style.conceptual.

This directive is only valid within a Metadata directive:

@Metadata {
   @DisplayName("Custom Symbol Name", style: conceptual)
}