t

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
Source
CommentFactory.scala
Linear Supertypes
CommentFactoryBase, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommentFactory
  2. CommentFactoryBase
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val global: Global
    Definition Classes
    CommentFactory → CommentFactoryBase

Concrete Value Members

  1. def comment(sym: Global.Symbol, linkTarget: (CommentFactory.this)#DocTemplateImpl, inTpl: (CommentFactory.this)#DocTemplateImpl): Option[Comment]
  2. 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, hideImplicitConversions0: List[Body] = List.empty, shortDescription0: List[Body] = List.empty): Comment
    Definition Classes
    CommentFactoryBase
  3. def defineComment(sym: Global.Symbol, linkTarget: (CommentFactory.this)#DocTemplateImpl, inTpl: (CommentFactory.this)#DocTemplateImpl): Option[Comment]

    A comment is usually 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 usually 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

  4. def parseWiki(string: String, pos: Position, inTpl: (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.
  5. def parseWikiAtSymbol(string: String, pos: Position, site: 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