DocComments

Type Members

case class DocComment(raw: String, pos: Global.Position = DocComments.this.NoPosition, codePos: Global.Position = DocComments.this.NoPosition) extends Product with Serializable
class ExpansionLimitExceeded extends Exception
case class UseCase(comment: Global.DocComment, body: String, pos: Global.Position) extends Product with Serializable

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clearDocComments(): Unit
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def cookedDocComment(sym: Global.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.
val cookedDocComments: HashMap[Global.Symbol, String]
def docComment(sym: Global.Symbol, docStr: String, pos: Global.Position = NoPosition): Any

Associate comment with symbol sym at position pos.
def docCommentPos(sym: Global.Symbol): Global.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.
val docComments: HashMap[Global.Symbol, Global.DocComment]

The raw doc comment map
def ensuring(cond: (DocComments) ⇒ Boolean, msg: ⇒ Any): DocComments

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

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

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

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

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

Definition Classes
AnyRef → Any
def expandInheritdoc(parent: String, child: String, sym: Global.Symbol): String

Expand inheritdoc tags
Expand inheritdoc tags
- for the main comment we transform the inheritdoc into the super variable, and the variable expansion can expand it further
- for the param, tparam and throws sections we must replace comments on the spot
This is done separately, for two reasons: 1. It takes longer to run compared to merge 2. The inheritdoc annotation should not be used very often, as building the comment from pieces severely impacts performance
parent
The source (or parent) comment
child
The child (overriding member or usecase) comment
sym
The child symbol
returns
The child comment with the inheritdoc sections expanded
def expandVariables(initialStr: String, sym: Global.Symbol, site: Global.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
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.)
def expandedDocComment(sym: Global.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)
def expandedDocComment(sym: Global.Symbol, site: Global.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.
def fillDocComment(sym: Global.Symbol, comment: Global.DocComment): Unit
def finalize(): Unit

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

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def lookupVariable(vble: String, site: Global.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
def merge(src: String, dst: String, sym: Global.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.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def rawDocComment(sym: Global.Symbol): String

The raw doc comment of symbol sym, as it appears in the source text, "" if missing.
def superComment(sym: Global.Symbol): Option[String]

The cooked doc comment of an overridden symbol
The cooked doc comment of an overridden symbol

Attributes
protected
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toJavaDoc(s: String): String

Returns the javadoc format of doc comment string s, including wiki expansion
def toString(): String

Definition Classes
AnyRef → Any
def useCases(sym: Global.Symbol): List[(Global.Symbol, String, Global.Position)]
def useCases(sym: Global.Symbol, site: Global.Symbol): List[(Global.Symbol, String, Global.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.
final def wait(): Unit

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

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

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

Implicit information
This member is added by an implicit conversion from DocComments to ArrowAssoc[DocComments] performed by method any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Shadowed Implicit Value Members

val self: Any
Implicit information
This member is added by an implicit conversion from DocComments 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:
(docComments: StringAdd).self
Definition Classes
StringAdd
val self: Any
Implicit information
This member is added by an implicit conversion from DocComments 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:
(docComments: StringFormat).self
Definition Classes
StringFormat

Deprecated Value Members

def x: DocComments
Implicit information
This member is added by an implicit conversion from DocComments to ArrowAssoc[DocComments] 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:
(docComments: ArrowAssoc[DocComments]).x
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use leftOfArrow instead
def x: DocComments
Implicit information
This member is added by an implicit conversion from DocComments to Ensuring[DocComments] 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:
(docComments: Ensuring[DocComments]).x
Definition Classes
Ensuring
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use resultOfEnsuring instead

trait DocComments extends AnyRef

Type Members

case class DocComment(raw: String, pos: Global.Position = DocComments.this.NoPosition, codePos: Global.Position = DocComments.this.NoPosition) extends Product with Serializable

class ExpansionLimitExceeded extends Exception

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

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (DocComments, B)

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clearDocComments(): Unit

def clone(): AnyRef

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

val cookedDocComments: HashMap[Global.Symbol, String]

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

def docCommentPos(sym: Global.Symbol): Global.Position

val docComments: HashMap[Global.Symbol, Global.DocComment]

def ensuring(cond: (DocComments) ⇒ Boolean, msg: ⇒ Any): DocComments

def ensuring(cond: (DocComments) ⇒ Boolean): DocComments

def ensuring(cond: Boolean, msg: ⇒ Any): DocComments

def ensuring(cond: Boolean): DocComments

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def expandInheritdoc(parent: String, child: String, sym: Global.Symbol): String

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

def expandWiki(str: String): String

def expandedDocComment(sym: Global.Symbol): String

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

def fillDocComment(sym: Global.Symbol, comment: Global.DocComment): Unit

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

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

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def rawDocComment(sym: Global.Symbol): String

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

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

def toJavaDoc(s: String): String

def toString(): String

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

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (DocComments, B)

Shadowed Implicit Value Members

val self: Any

val self: Any

Deprecated Value Members

def x: DocComments

def x: DocComments

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DocComments to StringAdd

Inherited by implicit conversion any2stringfmt from DocComments to StringFormat

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

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

Ungrouped