Dotty Documentation

0.5.0-bin-SNAPSHOT

package dotty.tools.dottydoc.model.comment

[-] Constructors

[-] Members

[+] sealed abstract class Block

A block-level element of text, such as a paragraph or code block.

[+] final case class Body

A body of text. A comment has a single body, which is composed of at least one block. Inside every body is exactly one summary (see [[scala.tools.nsc.doc.model.comment.Summary]]).

[+] object Body

A body of text. A comment has a single body, which is composed of at least one block. Inside every body is exactly one summary (see [[scala.tools.nsc.doc.model.comment.Summary]]).

[+] final case class Bold
[+] object Bold
[+] final case class Chain
[+] object Chain
[+] sealed class CharReader
[+] final case class Code
[+] object Code
[+] case class Comment
[+] object Comment
[+] trait CommentCleaner
[+] trait CommentParser
[+] final case class DefinitionList
[+] object DefinitionList
[+] object EntityLink
[+] final case class HorizontalRule
[+] object HorizontalRule
[+] object HtmlParsers
[+] final case class HtmlTag
[+] object HtmlTag
[+] sealed abstract class Inline

An section of text inside a block, possibly with formatting.

[+] final case class Italic
[+] object Italic
[+] object Link
[+] sealed trait LinkTo
[+] final case class LinkToEntity

Linking directly to entities is not picklable because of cyclic references

[+] object LinkToEntity

Linking directly to entities is not picklable because of cyclic references

[+] final case class LinkToExternal
[+] object LinkToExternal
[+] case class MarkdownComment
[+] object MarkdownComment
[+] class MarkdownShortener

The MarkdownShortener takes a node and mutates it and all children so that the displayed length of the generated HTML doesn't exceeed maxLen. This number defaults to 150 characters.

[+] trait MarkupConversion
[+] final case class Monospace
[+] object Monospace
[+] final case class OrderedList
[+] object OrderedList
[+] final case class Paragraph
[+] object Paragraph
[+] case class ParsedComment
[+] object ParsedComment
[+] object Regexes
[+] final case class Subscript
[+] object Subscript
[+] final case class Summary

The summary of a comment, usually its first sentence. There must be exactly one summary per body.

[+] object Summary

The summary of a comment, usually its first sentence. There must be exactly one summary per body.

[+] final case class Superscript
[+] object Superscript
[+] final case class Text
[+] object Text
[+] final case class Title
[+] object Title
[+] final case class Tooltip
[+] object Tooltip
[+] final case class Underline
[+] object Underline
[+] final case class UnorderedList
[+] object UnorderedList
[+] case class WikiComment
[+] object WikiComment
[+] final class WikiParser

Original wikiparser from NSC