scaladoc
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
scaladoc/dotty.tools.scaladoc.tasty.comments.wiki

dotty.tools.scaladoc.tasty.comments.wiki

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

Members list

Concise view

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.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Code
object HorizontalRule.type
class Paragraph
class Table
class Title
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).

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class Bold(text: Inline) extends Inline

Attributes

Graph
Supertypes
trait Product
trait Equals
class Inline
class Object
trait Matchable
class Any
final case class Cell(blocks: Seq[Block])

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class Chain(items: Seq[Inline]) extends Inline

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Inline
class Object
trait Matchable
class Any
object Chain

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Chain.type
sealed class CharReader(buffer: String)

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Parser
Self type
final case class Code(data: String) extends Block

Attributes

Graph
Supertypes
trait Product
trait Equals
class Block
class Object
trait Matchable
class Any
final case class ColumnOption(option: 'L' | 'C' | 'R')

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
object ColumnOption

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class DefinitionList(items: SortedMap[Inline, Block]) extends Block

Attributes

Graph
Supertypes
trait Product
trait Equals
class Block
class Object
trait Matchable
class Any
object HorizontalRule extends Block

Attributes

Graph
Supertypes
class Block
class Object
trait Matchable
class Any
Self type
final case class HtmlTag(data: String) extends Inline

Attributes

Graph
Supertypes
trait Product
trait Equals
class Inline
class Object
trait Matchable
class Any
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.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Bold
class Chain
class HtmlTag
class Italic
class Link
class Monospace
class Subscript
class Summary
class Text
class Underline
final case class Italic(text: Inline) extends Inline

Attributes

Graph
Supertypes
trait Product
trait Equals
class Inline
class Object
trait Matchable
class Any
final case class Link(link: DocLink, title: Option[Inline]) extends Inline

Attributes

Graph
Supertypes
trait Product
trait Equals
class Inline
class Object
trait Matchable
class Any
sealed trait LinkTo

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
final case class Monospace(text: Inline) extends Inline

Attributes

Graph
Supertypes
trait Product
trait Equals
class Inline
class Object
trait Matchable
class Any
final case class OrderedList(items: Seq[Block], style: String) extends Block

Attributes

Graph
Supertypes
trait Product
trait Equals
class Block
class Object
trait Matchable
class Any
final case class Paragraph(text: Inline) extends Block

Attributes

Graph
Supertypes
trait Product
trait Equals
class Block
class Object
trait Matchable
class Any
final class Parser(val buffer: String, linkResolver: (String, Option[Inline]) => Inline) extends CharReader

Original wikiparser from NSC

Original wikiparser from NSC

Attributes

Authors:

Ingo Maier

Manohar Jonnalagedda

Gilles Dubochet

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
abstract class RepresentationLink(val title: Inline) extends Inline

Attributes

Companion:
object
Graph
Supertypes
class Inline
class Object
trait Matchable
class Any
object RepresentationLink

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
final case class Row(cells: Seq[Cell])

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class Subscript(text: Inline) extends Inline

Attributes

Graph
Supertypes
trait Product
trait Equals
class Inline
class Object
trait Matchable
class Any
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.

Attributes

Graph
Supertypes
trait Product
trait Equals
class Inline
class Object
trait Matchable
class Any
final case class Superscript(text: Inline) extends Inline

Attributes

Graph
Supertypes
trait Product
trait Equals
class Inline
class Object
trait Matchable
class Any
final case class Table(header: Row, columnOptions: Seq[ColumnOption], rows: Seq[Row]) extends Block

Attributes

Graph
Supertypes
trait Product
trait Equals
class Block
class Object
trait Matchable
class Any
final case class Text(text: String) extends Inline

Attributes

Graph
Supertypes
trait Product
trait Equals
class Inline
class Object
trait Matchable
class Any
final case class Title(text: Inline, level: Int) extends Block

Attributes

Graph
Supertypes
trait Product
trait Equals
class Block
class Object
trait Matchable
class Any
final case class Underline(text: Inline) extends Inline

Attributes

Graph
Supertypes
trait Product
trait Equals
class Inline
class Object
trait Matchable
class Any
final case class UnorderedList(items: Seq[Block]) extends Block

Attributes

Graph
Supertypes
trait Product
trait Equals
class Block
class Object
trait Matchable
class Any
sealed abstract class WikiDocElement

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Block
class Code
object HorizontalRule.type
class Paragraph
class Table
class Title
class Inline
class Bold
class Chain
class HtmlTag
class Italic
class Link
class Monospace
class Subscript
class Summary
class Text
class Underline
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL