scaladoc/dotty.tools.scaladoc.tasty.comments.wiki

dotty.tools.scaladoc.tasty.comments.wiki

package dotty.tools.scaladoc.tasty.comments.wiki

Type members

Classlikes

sealed abstract class Block extends WikiDocElement

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

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

final case class Body(blocks: Seq[Block])

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).

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(text: Inline) extends Inline
final case class Cell(blocks: Seq[Block])
final case class Chain(items: Seq[Inline]) extends Inline
Companion:
object
object Chain
Companion:
class
sealed class CharReader(buffer: String)
final case class Code(data: String) extends Block
final case class ColumnOption(option: 'L' | 'C' | 'R')
Companion:
object
object ColumnOption
Companion:
class
final case class DefinitionList(items: SortedMap[Inline, Block]) extends Block
object HorizontalRule extends Block
final case class HtmlTag(data: String) extends Inline
sealed abstract class Inline extends WikiDocElement

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

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

final case class Italic(text: Inline) extends Inline
final case class Link(link: DocLink, title: Option[Inline]) extends Inline
sealed trait LinkTo
final case class Monospace(text: Inline) extends Inline
final case class OrderedList(items: Seq[Block], style: String) extends Block
final case class Paragraph(text: Inline) extends Block
final class Parser(val buffer: String, linkResolver: (String, Option[Inline]) => Inline) extends CharReader

Original wikiparser from NSC

Original wikiparser from NSC

Authors:

Ingo Maier

Manohar Jonnalagedda

Gilles Dubochet

abstract class RepresentationLink(val title: Inline) extends Inline
Companion:
object
object RepresentationLink
Companion:
class
final case class Row(cells: Seq[Cell])
final case class Subscript(text: Inline) extends Inline
final case class Summary(text: Inline) extends Inline

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

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

final case class Superscript(text: Inline) extends Inline
final case class Table(header: Row, columnOptions: Seq[ColumnOption], rows: Seq[Row]) extends Block
final case class Text(text: String) extends Inline
final case class Title(text: Inline, level: Int) extends Block
final case class Underline(text: Inline) extends Inline
final case class UnorderedList(items: Seq[Block]) extends Block
sealed abstract class WikiDocElement