scala.tools.nsc.doc.model.comment.CommentFactory.WikiParser

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

WikiParser
CharReader
AnyRef
Any

Visibility

Public
All

Instance Constructors

new WikiParser (buffer: Array[Char], pos: Position)

Value Members

def != (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def != (arg0: Any): Boolean

Attributes
final
Definition Classes
Any
def ## (): Int

Attributes
final
Definition Classes
AnyRef → Any
def == (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def == (arg0: Any): Boolean

Attributes
final
Definition Classes
Any
val CLOSE_TAG : Regex
val OPEN_TAG : Regex
def asInstanceOf [T0] : T0

Attributes
final
Definition Classes
Any

def block (): Block

 block ::= code | title | hrule | para

def blockEnded (blockType: String): Unit
```
 eol ::= { whitespace } '\n' 
```
def bold (): Inline
val buffer : Array[Char]
var char : Char

Definition Classes
CharReader
def check (chars: Array[Char]): Boolean

Attributes
final
Definition Classes
CharReader
def checkList : Boolean

Checks if the current line is formed with more than one space and one the listStyles
def checkParaEnded (): Boolean
def checkSkipInitWhitespace (chars: Array[Char]): Boolean

Definition Classes
CharReader
def checkedJump (chars: Array[Char]): Boolean

Attributes
final
Definition Classes
CharReader
def clone (): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def code (): Block
def countWhitespace : Int

Definition Classes
CharReader
def document (): Body
def entityLink (query: String): Inline
def eq (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def equals (arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize (): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def getClass (): java.lang.Class[_]

Attributes
final
Definition Classes
AnyRef → Any
def getRead (): String

Attributes
final
Definition Classes
CharReader
def hashCode (): Int

Definition Classes
AnyRef → Any
def hrule (): Block
```
 hrule ::= "----" { '-' } '\n' 
```
def htmlTag (): HtmlTag
def inline (isInlineEnd: ⇒ Boolean): Inline
def isInstanceOf [T0] : Boolean

Attributes
final
Definition Classes
Any
def isWhitespace (c: Char): Boolean

Definition Classes
CharReader
def italic (): Inline
def jump (chars: Array[Char]): Boolean

jumps all the characters in chars, consuming them in the process.
jumps all the characters in chars, consuming them in the process.
returns
true only if the correct characters have been jumped

Attributes
final
Definition Classes
CharReader
def jump (ch: Char): Boolean

jumps a character and consumes it
jumps a character and consumes it
returns
true only if the correct character has been jumped

Attributes
final
Definition Classes
CharReader
def jumpUntil (pred: ⇒ Boolean): Int

Attributes
final
Definition Classes
CharReader
def jumpUntil (chars: Array[Char]): Int

Attributes
final
Definition Classes
CharReader
def jumpUntil (ch: Char): Int

Attributes
final
Definition Classes
CharReader
def jumpWhitespace (): Int

Definition Classes
CharReader
def link (): Inline
def listBlock : Block
```
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.
val listStyles : Map[String, (Seq[Block]) ⇒ Block]

listStyle ::= '-' spc | '1.
listStyle ::= '-' spc | '1.' spc | 'I.' spc | 'i.' spc | 'A.' spc | 'a.' spc Characters used to build lists and their constructors

Attributes
protected
def monospace (): Inline
def ne (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def nextChar (): Unit

Attributes
final
Definition Classes
CharReader
def notify (): Unit

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Attributes
final
Definition Classes
AnyRef
var offset : Int

Definition Classes
CharReader
def para (): Block
```
 para ::= inline '\n' 
```
def readUntil (pred: ⇒ Boolean): Int

Attributes
final
Definition Classes
CharReader
def readUntil (chars: Array[Char]): Int

Attributes
final
Definition Classes
CharReader
def readUntil (ch: Char): Int

Attributes
final
Definition Classes
CharReader
def repeatJump (chars: Array[Char]): Int

Attributes
final
Definition Classes
CharReader
def repeatJump (chars: Array[Char], max: Int): Int

Attributes
final
Definition Classes
CharReader
def reportError (pos: Position, message: String): Unit
def store (body: ⇒ Unit): String

Definition Classes
CharReader
implicit def strintToChars (s: String): Array[Char]

Attributes
implicit
Definition Classes
CharReader
def subscript (): Inline
def summary (): Inline
var summaryParsed : Boolean
def superscript (): Inline
def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
Definition Classes
AnyRef

def title (): Block

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

def toString (): String

Definition Classes
AnyRef → Any
def underline (): Inline
def wait (): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def wait (arg0: Long, arg1: Int): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def wait (arg0: Long): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()

WikiParser

class WikiParser extends CharReader

Instance Constructors

new WikiParser (buffer: Array[Char], pos: Position)

Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

val CLOSE_TAG : Regex

val OPEN_TAG : Regex

def asInstanceOf [T0] : T0

def block (): Block

def blockEnded (blockType: String): Unit

def bold (): Inline

val buffer : Array[Char]

var char : Char

def check (chars: Array[Char]): Boolean

def checkList : Boolean

def checkParaEnded (): Boolean

def checkSkipInitWhitespace (chars: Array[Char]): Boolean

def checkedJump (chars: Array[Char]): Boolean

def clone (): AnyRef

def code (): Block

def countWhitespace : Int

def document (): Body

def entityLink (query: String): Inline

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def finalize (): Unit

def getClass (): java.lang.Class[_]

def getRead (): String

def hashCode (): Int

def hrule (): Block

def htmlTag (): HtmlTag

def inline (isInlineEnd: ⇒ Boolean): Inline

def isInstanceOf [T0] : Boolean

def isWhitespace (c: Char): Boolean

def italic (): Inline

def jump (chars: Array[Char]): Boolean

def jump (ch: Char): Boolean

def jumpUntil (pred: ⇒ Boolean): Int

def jumpUntil (chars: Array[Char]): Int

def jumpUntil (ch: Char): Int

def jumpWhitespace (): Int

def link (): Inline

def listBlock : Block

val listStyles : Map[String, (Seq[Block]) ⇒ Block]

def monospace (): Inline

def ne (arg0: AnyRef): Boolean

def nextChar (): Unit

def notify (): Unit

def notifyAll (): Unit

var offset : Int

def para (): Block

def readUntil (pred: ⇒ Boolean): Int

def readUntil (chars: Array[Char]): Int

def readUntil (ch: Char): Int

def repeatJump (chars: Array[Char]): Int

def repeatJump (chars: Array[Char], max: Int): Int

def reportError (pos: Position, message: String): Unit

def store (body: ⇒ Unit): String

implicit def strintToChars (s: String): Array[Char]

def subscript (): Inline

def summary (): Inline

var summaryParsed : Boolean

def superscript (): Inline

def synchronized [T0] (arg0: ⇒ T0): T0

def title (): Block

def toString (): String

def underline (): Inline

def wait (): Unit

def wait (arg0: Long, arg1: Int): Unit

def wait (arg0: Long): Unit

Inherited from CharReader

Inherited from AnyRef

Inherited from Any