scala.tools.nsc.interactive

Doc

abstract class Doc extends MemberLookupBase with CommentFactoryBase

Source
Doc.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Doc
  2. CommentFactoryBase
  3. MemberLookupBase
  4. AnyRef
  5. 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 Doc(settings: doc.Settings)

Type Members

  1. sealed class CharReader extends AnyRef

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  2. final case class SimpleTagKey(name: String) extends (CommentFactoryBase.this)#TagKey with Product with Serializable

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  3. final case class SymbolTagKey(name: String, symbol: String) extends (CommentFactoryBase.this)#TagKey with Product with Serializable

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  4. sealed abstract class TagKey extends AnyRef

    A key used for a tag map.

  5. final class WikiParser extends (CommentFactoryBase.this)#CharReader

    TODO

Abstract Value Members

  1. abstract def chooseLink(links: List[LinkTo]): LinkTo

    Definition Classes
    DocMemberLookupBase
  2. abstract val global: Global

    Definition Classes
    DocCommentFactoryBaseMemberLookupBase

Concrete 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 Doc to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Doc, B)

    Implicit information
    This member is added by an implicit conversion from Doc to ArrowAssoc[Doc] 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 CleanCommentLine: Regex

    The body of a line, dropping the (optional) start star-marker, one leading whitespace and all trailing whitespace.

    The body of a line, dropping the (optional) start star-marker, one leading whitespace and all trailing whitespace.

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  9. val CodeBlockEnd: Regex

    The end of a scaladoc code block

    The end of a scaladoc code block

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  10. val CodeBlockStart: Regex

    The start of a scaladoc code block

    The start of a scaladoc code block

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  11. val DangerousTags: Regex

    Dangerous HTML tags that should be replaced by something safer, such as wiki syntax, or that should be dropped.

    Dangerous HTML tags that should be replaced by something safer, such as wiki syntax, or that should be dropped.

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  12. val JavadocTags: Regex

    Javadoc tags that should be replaced by something useful, such as wiki syntax, or that should be dropped.

    Javadoc tags that should be replaced by something useful, such as wiki syntax, or that should be dropped.

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  13. val SafeTags: Regex

    Safe HTML tags that can be kept.

    Safe HTML tags that can be kept.

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  14. val SimpleTag: Regex

    A Scaladoc tag not linked to a symbol.

    A Scaladoc tag not linked to a symbol. Returns the name of the tag, and the rest of the line.

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  15. val SingleTag: Regex

    A Scaladoc tag not linked to a symbol and not followed by text

    A Scaladoc tag not linked to a symbol and not followed by text

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  16. val SymbolTag: Regex

    A Scaladoc tag linked to a symbol.

    A Scaladoc tag linked to a symbol. Returns the name of the tag, the name of the symbol, and the rest of the line.

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  17. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  18. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  19. def createComment(body0: Option[Body] = None, authors0: List[Body] = List.empty, see0: List[Body] = List.empty, result0: Option[Body] = None, throws0: Map[String, Body] = Map.empty, valueParams0: Map[String, Body] = Map.empty, typeParams0: Map[String, Body] = Map.empty, version0: Option[Body] = None, since0: Option[Body] = None, todo0: List[Body] = List.empty, deprecated0: Option[Body] = None, note0: List[Body] = List.empty, example0: List[Body] = List.empty, constructor0: Option[Body] = None, source0: Option[String] = None, inheritDiagram0: List[String] = List.empty, contentDiagram0: List[String] = List.empty, group0: Option[Body] = None, groupDesc0: Map[String, Body] = Map.empty, groupNames0: Map[String, Body] = Map.empty, groupPrio0: Map[String, Body] = Map.empty): Comment

    Definition Classes
    CommentFactoryBase
  20. val endOfLine: Char

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  21. val endOfText: Char

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  22. def ensuring(cond: (Doc) ⇒ Boolean, msg: ⇒ Any): Doc

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  28. def externalSignature(sym: Global.Symbol): String

    Definition Classes
    MemberLookupBase
  29. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  30. def findExternalLink(sym: Global.Symbol, name: String): Option[LinkToExternal]

    Definition Classes
    MemberLookupBase
  31. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any
  34. def htmlReplacement(mtch: Match): String

    Maps a dangerous HTML tag to a safe wiki replacement, or an empty string if it cannot be salvaged.

    Maps a dangerous HTML tag to a safe wiki replacement, or an empty string if it cannot be salvaged.

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  35. def internalLink(sym: Global.Symbol, site: Global.Symbol): Option[LinkTo]

    Definition Classes
    DocMemberLookupBase
  36. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  37. def javadocReplacement(mtch: Match): String

    Maps a javadoc tag to a useful wiki replacement, or an empty string if it cannot be salvaged.

    Maps a javadoc tag to a useful wiki replacement, or an empty string if it cannot be salvaged.

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  38. def makeEntityLink(title: Inline, pos: Global.Position, query: String, siteOpt: Option[Global.Symbol]): EntityLink { lazy val link: scala.tools.nsc.doc.base.LinkTo }

    Definition Classes
    MemberLookupBase
  39. def memberLookup(pos: Global.Position, query: String, siteOpt: Option[Global.Symbol]): LinkTo

    Definition Classes
    MemberLookupBase
  40. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  41. final def notify(): Unit

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

    Definition Classes
    AnyRef
  43. def oops(msg: String): Nothing

    Something that should not have happened, happened, and Scaladoc should exit.

    Something that should not have happened, happened, and Scaladoc should exit.

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  44. def parseAtSymbol(comment: String, src: String, pos: Position, siteOpt: Option[Global.Symbol] = None): Comment

    Parses a raw comment string into a Comment object.

    Parses a raw comment string into a Comment object.

    comment

    The expanded comment string (including start and end markers) to be parsed.

    src

    The raw comment source string.

    pos

    The position of the comment in source.

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  45. def parseWikiAtSymbol(string: String, pos: Position, siteOpt: Option[Global.Symbol]): Body

    Parses a string containing wiki syntax into a Comment object.

    Parses a string containing wiki syntax into a Comment object. Note that the string is assumed to be clean:

    • Removed Scaladoc start and end markers.
    • Removed start-of-line star and one whitespace afterwards (if present).
    • Removed all end-of-line whitespace.
    • Only endOfLine is used to mark line endings.
    Definition Classes
    CommentFactoryBase
  46. def retrieve(sym: Global.Symbol, site: Global.Symbol): Option[DocResult]

  47. val safeTagMarker: Char

    Attributes
    protected
    Definition Classes
    CommentFactoryBase
  48. val settings: doc.Settings

    Definition Classes
    DocMemberLookupBase
  49. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  50. def toString(link: LinkTo): String

    Definition Classes
    DocMemberLookupBase
  51. def toString(): String

    Definition Classes
    AnyRef → Any
  52. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  55. def [B](y: B): (Doc, B)

    Implicit information
    This member is added by an implicit conversion from Doc to ArrowAssoc[Doc] 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 Doc 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:
    (doc: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Doc 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:
    (doc: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Doc

    Implicit information
    This member is added by an implicit conversion from Doc to ArrowAssoc[Doc] 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:
    (doc: ArrowAssoc[Doc]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Doc

    Implicit information
    This member is added by an implicit conversion from Doc to Ensuring[Doc] 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:
    (doc: Ensuring[Doc]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from CommentFactoryBase

Inherited from MemberLookupBase

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Doc to StringAdd

Inherited by implicit conversion any2stringfmt from Doc to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Doc to ArrowAssoc[Doc]

Inherited by implicit conversion any2Ensuring from Doc to Ensuring[Doc]

Ungrouped