CommentExpander

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

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

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

6. def cookedDocComment(sym: Symbol, docStr: String = "")(implicit ctx: Context): 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.

7. def defineVariables(sym: Symbol)(implicit ctx: Context): Unit

   

8. def defines(raw: String): List[String]

   

9. def docCommentPos(sym: Symbol)(implicit ctx: Context): 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.

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

    

    Definition Classes

    AnyRef

11. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

12. def expand(sym: Symbol, site: Symbol)(implicit ctx: Context): String

    

13. def expandInheritdoc(parent: String, child: String, sym: 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

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

    

    Attributes

    protected

15. def expandedDocComment(sym: Symbol, site: Symbol, docStr: String = "")(implicit ctx: Context): 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.

16. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

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

    

    Definition Classes

    AnyRef → Any

18. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

19. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

20. def lookupVariable(vble: String, site: Symbol)(implicit ctx: Context): 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

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

    

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

    

    Definition Classes

    AnyRef

23. final def notify(): Unit

    

    Definition Classes

    AnyRef

24. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

25. def superComment(sym: Symbol)(implicit ctx: Context): Option[String]

    

    The cooked doc comment of an overridden symbol

    The cooked doc comment of an overridden symbol

    Attributes

    protected

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

    

    Definition Classes

    AnyRef

27. def toString(): String

    

    Definition Classes

    AnyRef → Any

28. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )