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

Parser

dotty.tools.scaladoc.tasty.comments.wiki.Parser
final class Parser(val buffer: String, linkResolver: (String, Option[Inline]) => Inline) extends CharReader

Original wikiparser from NSC

Attributes

Authors:

Ingo Maier

Manohar Jonnalagedda

Gilles Dubochet

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Value members

Concrete methods

def block(): Block
 block ::= code | title | hrule | listBlock | para

Attributes

def blockEnded(blockType: String): Unit
 eol ::= { whitespace } '\n'

Attributes

def bold(): Inline
def checkList: Boolean

Checks if the current line is formed with more than one space and one the listStyles

Checks if the current line is formed with more than one space and one the listStyles

Attributes

def code(): Block
def document(): Body
def getInline(isInlineEnd: => Boolean, textTransform: String => String): Inline
def hrule(): Block
 hrule ::= "----" { '-' } '\n'

Attributes

def italic(): Inline
def listBlock(): Block

Where n and m stand for the number of spaces. When m > n, a new list is nested.

nListBlock ::= nLine { mListBlock }
    nLine ::= nSpc listStyle para '\n'

Where n and m stand for the number of spaces. When m > n, a new list is nested.

Attributes

def normalizeIndentation(_code: String): String

Eliminates the (common) leading spaces in all lines, based on the first line For indented pieces of code, it reduces the indent to the least whitespace prefix:

Eliminates the (common) leading spaces in all lines, based on the first line For indented pieces of code, it reduces the indent to the least whitespace prefix:

     indented example
     another indented line
     if (condition)
       then do something;
     ^ this is the least whitespace prefix

Attributes

def para(): Block
 para ::= inline '\n'

Attributes

def reportError(message: String): Unit
def table(): Block
table         ::= headerRow '\n' delimiterRow '\n' dataRows '\n'
content       ::= inline-content
row           ::= '|' { content '|' }+
headerRow     ::= row
dataRows      ::= row*
align         ::= ':' '-'+ | '-'+ | '-'+ ':' | ':' '-'+ ':'
delimiterRow :: = '|' { align '|' }+

Attributes

def title(): Block
 title ::= ('=' inline '=' | "==" inline "==" | ...) '\n'

Attributes

Inherited methods

def char: Char

Attributes

Inherited from:
CharReader
final def check(chars: String, checkOffset: Int): Boolean

Attributes

Inherited from:
CharReader
final def check(chars: String): Boolean

Attributes

Inherited from:
CharReader
def checkSkipInitWhitespace(chars: String): Boolean

Attributes

Inherited from:
CharReader
def checkSkipInitWhitespace(c: Char): Boolean

Attributes

Inherited from:
CharReader
def countWhitespace: Int

Attributes

Inherited from:
CharReader
def isWhitespace(c: Char): Boolean

Attributes

Inherited from:
CharReader
def isWhitespaceOrNewLine(c: Char): Boolean

Attributes

Inherited from:
CharReader
final def jump(chars: String): Boolean

Jumps all the characters in chars, consuming them in the process.

Jumps all the characters in chars, consuming them in the process.

Attributes

Returns:

true only if the correct characters have been jumped

Inherited from:
CharReader
final def jump(ch: Char): Boolean

Jumps a character and consumes it

Jumps a character and consumes it

Attributes

Returns:

true only if the correct character has been jumped

Inherited from:
CharReader
final def jumpUntil(pred: => Boolean): Int

Attributes

Inherited from:
CharReader
final def jumpUntil(ch: Char): Int

Attributes

Inherited from:
CharReader
def jumpWhitespace(): Int

Attributes

Inherited from:
CharReader
def jumpWhitespaceOrNewLine(): Int

Attributes

Inherited from:
CharReader
final def nextChar(): Unit

Attributes

Inherited from:
CharReader
final def prevChar(): Unit

Attributes

Inherited from:
CharReader
final def readUntil(pred: => Boolean): String

Attributes

Inherited from:
CharReader
final def readUntil(chars: String): String

Attributes

Inherited from:
CharReader
final def readUntil(c: Char): String

Attributes

Inherited from:
CharReader
final def repeatJump(c: Char, max: Int): Int

Attributes

Inherited from:
CharReader

Concrete fields

Inherited fields

var offset: Int

Attributes

Inherited from:
CharReader
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL