Skip Navigation
Type MethodMethod

markup(_:)

Returns the escaped HTML of a text with word break opportunities.

static func markup(_ text: String) -> String

Parameters

text

The plain text, such as a symbol name.

Return Value

The HTML-escaped text with <wbr> elements at the boundaries.

Discussion

The text is scanned from the start like swift-docc-render’s regular expression ([a-z](?=[A-Z])|(:)\w|\w(?=[._]\w)): after each match the scan continues behind the characters the match consumed, and the break is placed after the first character of the match.