SKAnnotation

open class SKAnnotation : SKGenericKindEntity<SKAnnotation.Kind>

Represents an annotation for the token of source text.

It refers to the text via offset + length entries. This includes syntactic annotations (e.g. keywords) and semantic ones. The semantic ones include the name and Unified Symbol Resolution (USR) of the referenced symbol.

Public Type Aliases

  • The UID for the declaration kind (function, class, etc.).

    Declaration

    Swift

    public typealias Kind = SKSourceKind

Public Stored Properties

  • The displayed name for the entity.

    Declaration

    Swift

    public let name: String?
  • usr

    The Unified Symbol Resolution (USR) string for the entity.

    Declaration

    Swift

    public let usr: String?

Public Initializers

  • Undocumented

    Declaration

    Swift

    required public init(from decoder: Decoder) throws

Overridden Methods

  • Undocumented

    Declaration

    Swift

    open override func encode(to encoder: Encoder) throws

Equatable Protocol