scala.tools.nsc.doc.model

CommentFactory

trait CommentFactory extends CommentFactoryBase

The comment parser transforms raw comment strings into Comment objects. Call parse to run the parser. Note that the parser is stateless and should only be built once for a given Scaladoc run.

Self Type
ModelFactory with CommentFactory with MemberLookup
Linear Supertypes
CommentFactoryBase, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CommentFactory
  2. CommentFactoryBase
  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

Type Members

  1. sealed class CharReader extends AnyRef

    Attributes
    protected
    Definition Classes
    CommentFactoryBase

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

    TODO

Abstract Value Members

  1. abstract val global: Global

    Definition Classes
    CommentFactory → CommentFactoryBase

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 CommentFactory to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (CommentFactory, B)

    Implicit information
    This member is added by an implicit conversion from CommentFactory to ArrowAssoc[CommentFactory] 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. def addCommentBody(sym: Global.Symbol, inTpl: (CommentFactory.this)#TemplateImpl, docStr: String, docPos: Global.Position): Global.Symbol

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def clone(): AnyRef

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

  11. def comment(sym: Global.Symbol, currentTpl: Option[(CommentFactory.this)#DocTemplateImpl], inTpl: (CommentFactory.this)#DocTemplateImpl): Option[Comment]

  12. val commentCache: HashMap[(Global.Symbol, (CommentFactory.this)#TemplateImpl), Comment]

    Attributes
    protected

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

  14. def defineComment(sym: Global.Symbol, currentTpl: Option[(CommentFactory.this)#DocTemplateImpl], inTpl: (CommentFactory.this)#DocTemplateImpl): Option[Comment]

    A comment is usualy created by the parser, however for some special cases we have to give some inTpl comments (parent class for example) to the comment of the symbol.

    A comment is usualy created by the parser, however for some special cases we have to give some inTpl comments (parent class for example) to the comment of the symbol. This function manages some of those cases : Param accessor and Primary constructor

  15. def ensuring(cond: (CommentFactory) ⇒ Boolean, msg: ⇒ Any): CommentFactory

    Implicit information
    This member is added by an implicit conversion from CommentFactory to Ensuring[CommentFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  16. def ensuring(cond: (CommentFactory) ⇒ Boolean): CommentFactory

    Implicit information
    This member is added by an implicit conversion from CommentFactory to Ensuring[CommentFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  17. def ensuring(cond: Boolean, msg: ⇒ Any): CommentFactory

    Implicit information
    This member is added by an implicit conversion from CommentFactory to Ensuring[CommentFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  18. def ensuring(cond: Boolean): CommentFactory

    Implicit information
    This member is added by an implicit conversion from CommentFactory to Ensuring[CommentFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  20. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  21. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  22. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from CommentFactory to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Definition Classes
    AnyRef → Any

  24. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  27. final def notify(): Unit

    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  29. def parse(comment: String, src: String, pos: Position, inTplOpt: Option[(CommentFactory.this)#DocTemplateImpl] = None): Comment

    Attributes
    protected

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

  31. def parseWiki(string: String, pos: Position, inTplOpt: Option[(CommentFactory.this)#DocTemplateImpl]): 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.

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

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

    Definition Classes
    AnyRef

  34. def toString(): String

    Definition Classes
    AnyRef → Any

  35. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  38. def →[B](y: B): (CommentFactory, B)

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

Shadowed Implicit Value Members

  1. val self: Any

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

  2. val self: Any

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

Deprecated Value Members

  1. def x: CommentFactory

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: CommentFactory

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from CommentFactoryBase

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CommentFactory to StringAdd

Inherited by implicit conversion any2stringfmt from CommentFactory to StringFormat

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

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

Ungrouped