scala.tools.nsc.doc.base.CommentFactoryBase

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
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WikiParser
  2. CharReader
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WikiParser(buffer: String, pos: Position, siteOpt: Option[Global.Symbol])

Value Members

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

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

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from (CommentFactoryBase.this)#WikiParser to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): ((CommentFactoryBase.this)#WikiParser, B)

    Implicit information
    This member is added by an implicit conversion from (CommentFactoryBase.this)#WikiParser to ArrowAssoc[(CommentFactoryBase.this)#WikiParser] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. val CLOSE_TAG: Regex

  9. val OPEN_TAG: Regex

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def block(): Block

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

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

  14. val buffer: String

  15. def char: Char

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

    Definition Classes
    CharReader
  17. def checkList: Boolean

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

  18. def checkParaEnded(): Boolean

  19. def checkSkipInitWhitespace(chars: String): Boolean

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

    Definition Classes
    CharReader
  21. def clone(): AnyRef

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

  23. def countWhitespace: Int

    Definition Classes
    CharReader
  24. def document(): Body

  25. def ensuring(cond: ((CommentFactoryBase.this)#WikiParser) ⇒ Boolean, msg: ⇒ Any): (CommentFactoryBase.this)#WikiParser

    Implicit information
    This member is added by an implicit conversion from (CommentFactoryBase.this)#WikiParser to Ensuring[(CommentFactoryBase.this)#WikiParser] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: ((CommentFactoryBase.this)#WikiParser) ⇒ Boolean): (CommentFactoryBase.this)#WikiParser

    Implicit information
    This member is added by an implicit conversion from (CommentFactoryBase.this)#WikiParser to Ensuring[(CommentFactoryBase.this)#WikiParser] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. def ensuring(cond: Boolean, msg: ⇒ Any): (CommentFactoryBase.this)#WikiParser

    Implicit information
    This member is added by an implicit conversion from (CommentFactoryBase.this)#WikiParser to Ensuring[(CommentFactoryBase.this)#WikiParser] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. def ensuring(cond: Boolean): (CommentFactoryBase.this)#WikiParser

    Implicit information
    This member is added by an implicit conversion from (CommentFactoryBase.this)#WikiParser to Ensuring[(CommentFactoryBase.this)#WikiParser] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  32. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from (CommentFactoryBase.this)#WikiParser to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  33. final def getClass(): Class[_]

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

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

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

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

  38. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    CharReader
  40. def italic(): Inline

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

    Definition Classes
    CharReader
  44. final def jumpUntil(chars: String): Int

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

    Definition Classes
    CharReader
  46. def jumpWhitespace(): Int

    Definition Classes
    CharReader
  47. def link(): Inline

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

  49. val listStyles: Map[String, (collection.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
  50. def monospace(): Inline

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

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

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

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

    Definition Classes
    AnyRef
  56. var offset: Int

    Definition Classes
    CharReader
  57. def para(): Block

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

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

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

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

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

  63. def subscript(): Inline

  64. def summary(): Inline

  65. var summaryParsed: Boolean

  66. def superscript(): Inline

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

    Definition Classes
    AnyRef
  68. def title(): Block

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

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

  71. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  74. def [B](y: B): ((CommentFactoryBase.this)#WikiParser, B)

    Implicit information
    This member is added by an implicit conversion from (CommentFactoryBase.this)#WikiParser to ArrowAssoc[(CommentFactoryBase.this)#WikiParser] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from (CommentFactoryBase.this)#WikiParser to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (wikiParser: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from (CommentFactoryBase.this)#WikiParser to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (wikiParser: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: (CommentFactoryBase.this)#WikiParser

    Implicit information
    This member is added by an implicit conversion from (CommentFactoryBase.this)#WikiParser to ArrowAssoc[(CommentFactoryBase.this)#WikiParser] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (wikiParser: ArrowAssoc[(CommentFactoryBase.this)#WikiParser]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: (CommentFactoryBase.this)#WikiParser

    Implicit information
    This member is added by an implicit conversion from (CommentFactoryBase.this)#WikiParser to Ensuring[(CommentFactoryBase.this)#WikiParser] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (wikiParser: Ensuring[(CommentFactoryBase.this)#WikiParser]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from (CommentFactoryBase.this)#CharReader

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from (CommentFactoryBase.this)#WikiParser to StringAdd

Inherited by implicit conversion any2stringfmt from (CommentFactoryBase.this)#WikiParser to StringFormat

Inherited by implicit conversion any2ArrowAssoc from (CommentFactoryBase.this)#WikiParser to ArrowAssoc[(CommentFactoryBase.this)#WikiParser]

Inherited by implicit conversion any2Ensuring from (CommentFactoryBase.this)#WikiParser to Ensuring[(CommentFactoryBase.this)#WikiParser]

Ungrouped