TopicRenderReference

A reference to another page of documentation in the current context.

struct TopicRenderReference

Topics

Structures

struct PropertyListKeyNames
The display name and raw key name for a property list key or entitlement key and configuration about which “name” to use for links to this page.

Initializers

Instance Properties

var abstract: [RenderInlineContent]
The abstract of the destination page.
var abstractVariants: VariantCollection<[RenderInlineContent]>
var conformance: ConformanceSection?
Information about conditional conformance for the symbol
var defaultImplementationCount: Int?
Number of default implementations for the symbol
var estimatedTime: String?
The estimated time to complete the topic.
var fragments: [DeclarationRenderSection.Token]?
The abbreviated declaration of the symbol to display in links
var fragmentsVariants: VariantCollection<[DeclarationRenderSection.Token]?>
var identifier: RenderReferenceIdentifier
The identifier of the reference.
var images: [TopicImage]
Author provided images that represent this page.
var isBeta: Bool
A value that indicates whether this symbol is built for a beta platform
var isDeprecated: Bool
A value that indicates whether this symbol is deprecated
var kind: RenderNode.Kind
The kind of page that’s referenced.
var navigatorTitle: [DeclarationRenderSection.Token]?
The abbreviated declaration of the symbol to display in navigation
var navigatorTitleVariants: VariantCollection<[DeclarationRenderSection.Token]?>
var propertyListKeyNames: TopicRenderReference.PropertyListKeyNames?
The names and style for a reference to a property list key or entitlement key.
var required: Bool
Whether the reference is required in its parent context.
var role: String?
The additional “role” assigned to the symbol, if any
var tags: [RenderNode.Tag]?
An optional list of text-based tags.
var title: String
The title of the destination page.
var titleVariants: VariantCollection<String>
The variants of the title.
var type: RenderReferenceType
The type of this reference.
var url: String
The topic url for the destination page.

Instance Methods

func encode(to: any Encoder) throws