scala.tools.nsc.ast

DocComments

trait DocComments extends AnyRef

Self Type
SymbolTable
Source
DocComments.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
BuilderGlobal, BuilderGlobal, DocParser, Global, Global, SymbolTable, compiler
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. DocComments
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Type Members

  1. case class DocComment(raw: String, pos: Position) extends Product with Serializable

  2. class ExpansionLimitExceeded extends Exception

  3. case class UseCase(comment: DocComment, body: String, pos: Position) extends Product with Serializable

Abstract Value Members

  1. abstract def reporter: Reporter

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. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  8. def cookedDocComment(sym: Symbol, docStr: String = ""): String

    The raw doc comment of symbol sym, minus @usecase and @define sections, augmented by missing sections of an inherited doc comment.

    The raw doc comment of symbol sym, minus @usecase and @define sections, augmented by missing sections of an inherited doc comment. If a symbol does not have a doc comment but some overridden version of it does, the doc comment of the overridden version is copied instead.

  9. def docComment(sym: Symbol, docStr: String, pos: Position = NoPosition): Any

    Associate comment with symbol sym at position pos.

  10. def docCommentPos(sym: Symbol): Position

    The position of the raw doc comment of symbol sym, or NoPosition if missing If a symbol does not have a doc comment but some overridden version of it does, the position of the doc comment of the overridden version is returned instead.

  11. val docComments: HashMap[Symbol, DocComment]

    The raw doc comment map

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

    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  14. def expandVariables(initialStr: String, sym: Symbol, site: Symbol): String

    Expand variable occurrences in string str', until a fix point is reached or a expandLimit is exceeded.

    Expand variable occurrences in string str', until a fix point is reached or a expandLimit is exceeded.

    sym

    The symbol for which doc comments are generated

    site

    The class for which doc comments are generated

    returns

    Expanded string

    Attributes
    protected

  15. def expandWiki(str: String): String

    Returns just the wiki expansion (this would correspond to a comment in the input format of the JavaDoc tool, modulo differences in tags.

    Returns just the wiki expansion (this would correspond to a comment in the input format of the JavaDoc tool, modulo differences in tags.)

  16. def expandedDocComment(sym: Symbol): String

    The cooked doc comment of symbol sym after variable expansion, or "" if missing.

    The cooked doc comment of symbol sym after variable expansion, or "" if missing.

    sym

    The symbol for which doc comment is returned (site is always the containing class)

  17. def expandedDocComment(sym: Symbol, site: Symbol, docStr: String = ""): String

    The cooked doc comment of symbol sym after variable expansion, or "" if missing.

    The cooked doc comment of symbol sym after variable expansion, or "" if missing.

    sym

    The symbol for which doc comment is returned

    site

    The class for which doc comments are generated

    Exceptions thrown
    ExpansionLimitExceeded

    when more than 10 successive expansions of the same string are done, which is interpreted as a recursive variable definition.

  18. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  19. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  22. def lookupVariable(vble: String, site: Symbol): Option[String]

    Lookup definition of variable.

    Lookup definition of variable.

    vble

    The variable for which a definition is searched

    site

    The class for which doc comments are generated

  23. def merge(src: String, dst: String, sym: Symbol, copyFirstPara: Boolean = false): String

    Merge elements of doccomment src into doc comment dst for symbol sym.

    Merge elements of doccomment src into doc comment dst for symbol sym. In detail:

    1. If copyFirstPara is true, copy first paragraph 2. For all parameters of sym if there is no @param section in dst for that parameter name, but there is one on src, copy that section. 3. If there is no @return section in dst but there is one in src, copy it.

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

    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  27. def rawDocComment(sym: Symbol): String

    The raw doc comment of symbol sym, as it appears in the source text, "" if missing.

  28. def superComment(sym: Symbol): Option[String]

    The cooked doc comment of an overridden symbol

    The cooked doc comment of an overridden symbol

    Attributes
    protected

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

    Definition Classes
    AnyRef

  30. def toJavaDoc(s: String): String

    Returns the javadoc format of doc comment string s, including wiki expansion

  31. def toString(): String

    Definition Classes
    AnyRef → Any

  32. def useCases(sym: Symbol): List[(Symbol, String, Position)]

  33. def useCases(sym: Symbol, site: Symbol): List[(Symbol, String, Position)]

    The list of use cases of doc comment of symbol sym seen as a member of class site.

    The list of use cases of doc comment of symbol sym seen as a member of class site. Each use case consists of a synthetic symbol (which is entered nowhere else), of an expanded doc comment string, and of its position.

    sym

    The symbol for which use cases are returned

    site

    The class for which doc comments are generated

    Exceptions thrown
    ExpansionLimitExceeded

    when more than 10 successive expansions of the same string are done, which is interpreted as a recursive variable definition.

  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  35. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  36. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any