SwiftDocC
Code

Class

Code

A code file to display alongside a Step.

final class Code

Topics

Initializers

convenience init?(from: BlockDirective, source: URL?, for: DocumentationBundle, problems: inout [Problem])

Instance Properties

let fileName: String
The name of the file, for display and identification purposes. If the fileName does not change between two consecutive steps (possibly across TutorialSections), the changes between the two files may be indicated in the UI.
let fileReference: ResourceReference
A reference to the file containing the code that should be loaded from the bundle.
let originalMarkup: BlockDirective
The original BlockDirective node that was parsed into this semantic code.
let preview: (any Media)?
A preview image or video overlay.
let previousFileReference: ResourceReference?
If specified, should present a diff between this property and fileReference.
let shouldResetDiff: Bool
Whether a diff should be shown. See fileName for more information.

Instance Methods

func accept<V>(inout V) -> V.Result

Type Properties