Class

scala.meta.internal.docstrings.ScaladocParser

WikiParser

Related Doc: package ScaladocParser

Permalink

final class WikiParser extends CharReader

TODO

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
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WikiParser(buffer: String, pos: meta.Position)

    Permalink

Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. val CLOSE_TAG: Regex

    Permalink
  5. val OPEN_TAG: Regex

    Permalink
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def block(): Block

    Permalink

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

    Permalink

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

    Permalink
  10. val buffer: String

    Permalink
  11. def char: Char

    Permalink
    Definition Classes
    CharReader
  12. final def check(chars: String, checkOffset: Int): Boolean

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

    Permalink
    Definition Classes
    CharReader
  14. def checkList: Boolean

    Permalink

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

  15. def checkParaEnded(): Boolean

    Permalink
  16. def checkSentenceEnded(): Boolean

    Permalink
  17. def checkSkipInitWhitespace(chars: String): Boolean

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

    Permalink
    Definition Classes
    CharReader
  19. def clone(): AnyRef

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

    Permalink
  21. def countWhitespace: Int

    Permalink
    Definition Classes
    CharReader
  22. def document(): Body

    Permalink
  23. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink

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

    Permalink
  30. def inline(isInlineEnd: ⇒ Boolean, textTransform: (String) ⇒ String = identity): Inline

    Permalink
  31. final def isInstanceOf[T0]: Boolean

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

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

    Permalink
    Definition Classes
    CharReader
  34. def italic(): Inline

    Permalink
  35. final def jump(chars: String): Boolean

    Permalink

    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
  36. final def jump(ch: Char): Boolean

    Permalink

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

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

    Permalink
    Definition Classes
    CharReader
  39. def jumpWhitespace(): Int

    Permalink
    Definition Classes
    CharReader
  40. def jumpWhitespaceOrNewLine(): Int

    Permalink
    Definition Classes
    CharReader
  41. def link(): Inline

    Permalink
  42. def listBlock(): Block

    Permalink

    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.

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

    Permalink

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

  44. def monospace(): Inline

    Permalink
  45. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  46. final def nextChar(): Unit

    Permalink
    Definition Classes
    CharReader
  47. def normalizeIndentation(_code: String): String

    Permalink

    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
  48. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  49. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  50. var offset: Int

    Permalink
    Definition Classes
    CharReader
  51. def para(): Block

    Permalink

    para ::= inline '\n'
  52. final def prevChar(): Unit

    Permalink
    Definition Classes
    CharReader
  53. final def readUntil(pred: ⇒ Boolean): String

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

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

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

    Permalink
    Definition Classes
    CharReader
  57. def reportError(pos: meta.Position, message: String): Unit

    Permalink
  58. def subscript(): Inline

    Permalink
  59. def summary(): Inline

    Permalink
  60. var summaryParsed: Boolean

    Permalink
  61. def superscript(): Inline

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

    Permalink
    Definition Classes
    AnyRef
  63. def table(): Block

    Permalink

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

    Permalink

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

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

    Permalink
  67. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CharReader

Inherited from AnyRef

Inherited from Any

Ungrouped