Dotty Documentation

0.12.0-bin-SNAPSHOT

object ParsedComment
extends Object

[-] Constructors

[-] Members

[+] private case class TagFormatter

Format the elements of documentation associated with a given tag using fn, and starts the section with title.

[+] private object TagFormatter

Format the elements of documentation associated with a given tag using fn, and starts the section with title.

[+] private val knownTags : ListMap [ String, TagFormatter ]

A mapping from tag name to TagFormatter

[+] @sharable private val prefixRegex : Regex
[+] private def bold ( str: String ) ( implicit ctx: Context ) : String

Show str in bold

[+] private def colorEnabled ( implicit ctx: Context ) : Boolean

Is the color enabled in the context?

[+] def docOf ( symbol: Symbol ) ( implicit ctx: Context ) : Option [ ParsedComment ]

Return the ParsedComment associated with symbol, if it exists.

[+] private def toCodeFence ( language: String ) ( ctx: Context , snippet: String ) : String

Formats snippet for display. If the color is enabled, the syntax is highlighted, otherwise the snippet is wrapped in a markdown code fence.

[+] private def toCodeFences ( language: String ) ( ctx: Context , snippets: List [ String ] ) : String

If the color is enabled, add syntax highlighting to each of snippets, otherwise wrap each of them in a markdown code fence. The results are put into a markdown list.

[+] private def toDescriptionList ( ctx: Context , items: List [ String ] ) : String

Formats a list of items into a list describing them.

Each element is assumed to consist of a first word, which is the item being described. The rest is the description of the item.

[+] private def toMarkdownList ( ctx: Context , items: List [ String ] ) : String

Formats a list of items into a markdown list.