Packages

  • package root

    The Scala compiler and reflection APIs.

    The Scala compiler and reflection APIs.

    Definition Classes
    root
  • package scala
    Definition Classes
    root
  • package tools
    Definition Classes
    scala
  • package nsc
    Definition Classes
    tools
  • package doc
    Definition Classes
    nsc
  • package base
    Definition Classes
    doc
  • trait CommentFactoryBase extends AnyRef

    The comment parser transforms raw comment strings into Comment objects.

    The comment parser transforms raw comment strings into Comment objects. Call parse to run the parser. Note that the parser is stateless and should only be built once for a given Scaladoc run.

    Definition Classes
    base
  • CharReader
  • WikiParser

final class WikiParser extends (CommentFactoryBase.this)#CharReader

TODO

Attributes
protected
Self Type
(CommentFactoryBase.this)#WikiParser
Source
CommentFactoryBase.scala
Linear Supertypes
(CommentFactoryBase.this)#CharReader, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WikiParser
  2. CharReader
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WikiParser(buffer: String, pos: Position, site: Global.Symbol)

Value Members

  1. val CLOSE_TAG: Regex
  2. val OPEN_TAG: Regex
  3. def block(): Block 

    block ::= code | title | hrule | listBlock | table | para
  4. def blockEnded(blockType: String): Unit 

    eol ::= { whitespace } '\n'
  5. def bold(): Inline
  6. val buffer: String
  7. def char: Char
    Definition Classes
    CharReader
  8. final def check(chars: String, checkOffset: Int): Boolean
    Definition Classes
    CharReader
  9. final def check(chars: String): Boolean
    Definition Classes
    CharReader
  10. def checkList: Boolean

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

  11. def checkParaEnded(): Boolean
  12. def checkSentenceEnded(): Boolean
  13. def checkSkipInitWhitespace(chars: String): Boolean
    Definition Classes
    CharReader
  14. def checkSkipInitWhitespace(c: Char): Boolean
    Definition Classes
    CharReader
  15. def code(): Block
  16. def countWhitespace: Int
    Definition Classes
    CharReader
  17. def document(): Body
  18. def hrule(): Block 

    hrule ::= "----" { '-' } '\n'
  19. def htmlTag(): HtmlTag
  20. def inline(isInlineEnd: ⇒ Boolean, textTransform: (String) ⇒ String = identity): Inline
  21. def isWhitespace(c: Char): Boolean
    Definition Classes
    CharReader
  22. def isWhitespaceOrNewLine(c: Char): Boolean
    Definition Classes
    CharReader
  23. def italic(): Inline
  24. 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.

    returns

    true only if the correct characters have been jumped

    Definition Classes
    CharReader
  25. final 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

    Definition Classes
    CharReader
  26. final def jumpUntil(pred: ⇒ Boolean): Int
    Definition Classes
    CharReader
  27. final def jumpUntil(ch: Char): Int
    Definition Classes
    CharReader
  28. def jumpWhitespace(): Int
    Definition Classes
    CharReader
  29. def jumpWhitespaceOrNewLine(): Int
    Definition Classes
    CharReader
  30. def link(): Inline
  31. 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.

  32. def monospace(): Inline
  33. final def nextChar(): Unit
    Definition Classes
    CharReader
  34. 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
  35. var offset: Int
    Definition Classes
    CharReader
  36. def para(): Block 

    para ::= inline '\n'
  37. final def prevChar(): Unit
    Definition Classes
    CharReader
  38. final def readUntil(pred: ⇒ Boolean): String
    Definition Classes
    CharReader
  39. final def readUntil(chars: String): String
    Definition Classes
    CharReader
  40. final def readUntil(c: Char): String
    Definition Classes
    CharReader
  41. final def repeatJump(c: Char, max: Int = Int.MaxValue): Int
    Definition Classes
    CharReader
  42. def reportError(pos: Position, message: String): Unit
  43. def subscript(): Inline
  44. def summary(): Inline
  45. var summaryParsed: Boolean
  46. def superscript(): Inline
  47. def table(): Block 

    table         ::= headerRow '\n' delimiterRow '\n' dataRows '\n'
content       ::= inline-content
row           ::= '|' { content '|' }+
headerRow     ::= row
dataRows      ::= row*
align         ::= ':' '-'+ | '-'+ | '-'+ ':' | ':' '-'+ ':'
delimiterRow :: = '|' { align '|' }+
  48. def title(): Block 

    title ::= ('=' inline '=' | "==" inline "==" | ...) '\n'
  49. def underline(): Inline