SwiftDocC
RenderIndex
RenderIndex.Node

Structure

RenderIndex.Node

A documentation node in a documentation render index.

struct Node

Topics

Initializers

init(from: any Decoder) throws
init(title: String, path: String?, type: String?, children: [RenderIndex.Node]?, isDeprecated: Bool, isExternal: Bool, isBeta: Bool, icon: RenderReferenceIdentifier?)
Creates a new node with the given title, path, type, and children.

Instance Properties

let children: [RenderIndex.Node]?
The children of this node.
let icon: RenderReferenceIdentifier?
A reference to a custom image for this node.
let isBeta: Bool
A Boolean value that is true if the current node has been marked as is beta
let isDeprecated: Bool
A Boolean value that is true if the current node has been marked as deprecated on any platform.
let isExternal: Bool
A Boolean value that is true if the current node belongs to an external documentation archive.
let path: String?
The relative path to the page represented by this node.
let title: String
The title of the node, suitable for presentation.
let type: String?
The type of this node.

Instance Methods

func encode(to: any Encoder) throws