RenderNodeTranslator

A visitor which converts a semantic model into a render node.

struct RenderNodeTranslator

Mentioned In

The Swift-DocC Pipeline

Discussion

The translator visits the contents of a DocumentationNode’s Semantic model and creates a RenderNode. The translation is lossy, meaning that translating a RenderNode back to a Semantic is not possible with full fidelity. For example, source markup syntax is not preserved during the translation.

Topics

Instance Methods

func visitArticle(Article) -> (any RenderTree)?
func visitAssessments(Assessments) -> (any RenderTree)?
func visitChapter(Chapter) -> (any RenderTree)?
func visitChoice(Choice) -> (any RenderTree)?
func visitCode(Code) -> (any RenderTree)?
func visitComment(Comment) -> (any RenderTree)?
func visitContentAndMedia(ContentAndMedia) -> (any RenderTree)?
func visitDeprecationSummary(DeprecationSummary) -> (any RenderTree)?
func visitImageMedia(ImageMedia) -> (any RenderTree)?
func visitIntro(Intro) -> (any RenderTree)?
func visitJustification(Justification) -> (any RenderTree)?
func visitLink(URL, defaultTitle: String?) -> RenderInlineContent
func visitMarkup(any Markup) -> (any RenderTree)?
func visitMarkup([any Markup]) -> (any RenderTree)?
func visitMarkupContainer(MarkupContainer) -> (any RenderTree)?
func visitMultipleChoice(MultipleChoice) -> (any RenderTree)?
func visitResolvedTopicReference(ResolvedTopicReference) -> any RenderTree
func visitResources(Resources) -> (any RenderTree)?
func visitStack(Stack) -> (any RenderTree)?
func visitStep(Step) -> (any RenderTree)?
func visitSteps(Steps) -> (any RenderTree)?
func visitSymbol(Symbol) -> (any RenderTree)?
func visitTechnology(TutorialTableOfContents) -> (any RenderTree)?
func visitTile(Tile) -> (any RenderTree)?
func visitTutorial(Tutorial) -> (any RenderTree)?
func visitTutorialArticle(TutorialArticle) -> (any RenderTree)?
func visitTutorialReference(TutorialReference) -> (any RenderTree)?
func visitTutorialSection(TutorialSection) -> (any RenderTree)?
func visitTutorialTableOfContents(TutorialTableOfContents) -> (any RenderTree)?
func visitVideoMedia(VideoMedia) -> (any RenderTree)?
func visitVolume(Volume) -> (any RenderTree)?
func visitXcodeRequirement(XcodeRequirement) -> (any RenderTree)?
Add a requirement reference and return its identifier.