Documentation Language: Swift

Structure

SymbolKind

A symbol kind for documentation display, wrapping DocumentationNode.Kind.

struct SymbolKind

Overview

This type provides convenient access to symbol kinds for rendering badges and categorising symbols in the documentation output.

Topics

Initializers

?
init(_:)

Creates a symbol kind from a DocumentationNode.Kind.

?
init(id:)

Creates a symbol kind from an identifier string.

?
init(keyword:)

Creates a symbol kind from a keyword string (e.g., “struct”, “class”, “enum”).

?
init(rawValue:)

Creates a symbol kind from a raw value (name).

Instance Properties

V
badgeCharacter

The badge character for this symbol kind.

V
badgeClass

The CSS class for this symbol kind’s badge.

V
id

The unique identifier for this symbol kind.

V
isSymbol

Whether this kind represents a symbol (as opposed to an article or tutorial).

V
kind

The underlying documentation node kind.

V
name

The display name for this symbol kind.

V
rawValue

The raw value (name) of this symbol kind.

Type Properties

Default Implementations

Relationships

Conforms To