dotty.tools.dottydoc.model.comment.CommentParser

WikiParser

Related Doc: package CommentParser

final class WikiParser extends CharReader

Original wikiparser from NSC

Attributes
protected
Self Type
WikiParser
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WikiParser
  2. CharReader
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WikiParser(entity: Entity, packages: Map[String, Package], buffer: String, pos: Position, site: Symbol)(implicit ctx: Context)

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Definition Classes
    AnyRef → Any
  4. val CLOSE_TAG: Regex

  5. val OPEN_TAG: Regex

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def block(): Block

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

    eol ::= { whitespace } '\n'
  9. def bold(): Inline

  10. val buffer: String

  11. def char: Char

    Definition Classes
    CharReader
  12. final def check(chars: String): Boolean

    Definition Classes
    CharReader
  13. def checkList: Boolean

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

  14. def checkParaEnded(): Boolean

  15. def checkSentenceEnded(): Boolean

  16. def checkSkipInitWhitespace(chars: String): Boolean

    Definition Classes
    CharReader
  17. def checkSkipInitWhitespace(c: Char): Boolean

    Definition Classes
    CharReader
  18. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def code(): Block

  20. def countWhitespace: Int

    Definition Classes
    CharReader
  21. def document(): Body

  22. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  24. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  26. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  27. def hrule(): Block

    hrule ::= "----" { '-' } '\n'
  28. def htmlTag(): HtmlTag

  29. def inline(isInlineEnd: ⇒ Boolean): Inline

  30. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  31. def isWhitespace(c: Char): Boolean

    Definition Classes
    CharReader
  32. def isWhitespaceOrNewLine(c: Char): Boolean

    Definition Classes
    CharReader
  33. def italic(): Inline

  34. 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
  35. 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
  36. final def jumpUntil(pred: ⇒ Boolean): Int

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

    Definition Classes
    CharReader
  38. def jumpWhitespace(): Int

    Definition Classes
    CharReader
  39. def jumpWhitespaceOrNewLine(): Int

    Definition Classes
    CharReader
  40. def link(): Inline

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

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

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

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

    Attributes
    protected
  43. def monospace(): Inline

  44. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  45. final def nextChar(): Unit

    Definition Classes
    CharReader
  46. 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
  47. final def notify(): Unit

    Definition Classes
    AnyRef
  48. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  49. var offset: Int

    Definition Classes
    CharReader
  50. def para(): Block

    para ::= inline '\n'
  51. final def readUntil(pred: ⇒ Boolean): String

    Definition Classes
    CharReader
  52. final def readUntil(chars: String): String

    Definition Classes
    CharReader
  53. final def readUntil(c: Char): String

    Definition Classes
    CharReader
  54. final def repeatJump(c: Char, max: Int = Int.MaxValue): Int

    Definition Classes
    CharReader
  55. def reportError(pos: Position, message: String): Unit

  56. def subscript(): Inline

  57. def summary(): Inline

  58. var summaryParsed: Boolean

  59. def superscript(): Inline

  60. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  61. def title(): Block

    title ::= ('=' inline '=' | "==" inline "==" | ...) '\n'
  62. def toString(): String

    Definition Classes
    AnyRef → Any
  63. def underline(): Inline

  64. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CharReader

Inherited from AnyRef

Inherited from Any

Ungrouped