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
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- CommentFactory
- CommentFactoryBase
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Type Members
- sealed class CharReader extends AnyRef
- Attributes
- protected
- Definition Classes
- CommentFactoryBase
- final class WikiParser extends (CommentFactoryBase.this)#CharReader
TODO
TODO
- Attributes
- protected
- Definition Classes
- CommentFactoryBase
Abstract Value Members
- abstract val global: Global
- Definition Classes
- CommentFactory → CommentFactoryBase
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from CommentFactory toany2stringadd[CommentFactory] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (CommentFactory, B)
- Implicit
- This member is added by an implicit conversion from CommentFactory toArrowAssoc[CommentFactory] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def comment(sym: Global.Symbol, linkTarget: (CommentFactory.this)#DocTemplateImpl, inTpl: (CommentFactory.this)#DocTemplateImpl): Option[Comment]
- val commentCache: HashMap[(Global.Symbol, (CommentFactory.this)#DocTemplateImpl), Option[Comment]]
- Attributes
- protected
- 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
- 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
inTplcomments (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
inTplcomments (parent class for example) to the comment of the symbol. This function manages some of those cases : Param accessor and Primary constructor - def ensuring(cond: (CommentFactory) => Boolean, msg: => Any): CommentFactory
- Implicit
- This member is added by an implicit conversion from CommentFactory toEnsuring[CommentFactory] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (CommentFactory) => Boolean): CommentFactory
- Implicit
- This member is added by an implicit conversion from CommentFactory toEnsuring[CommentFactory] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): CommentFactory
- Implicit
- This member is added by an implicit conversion from CommentFactory toEnsuring[CommentFactory] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): CommentFactory
- Implicit
- This member is added by an implicit conversion from CommentFactory toEnsuring[CommentFactory] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): java.lang.Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def parse(comment: String, src: String, pos: Position, linkTarget: (CommentFactory.this)#DocTemplateImpl): Comment
- Attributes
- protected
- def parseAtSymbol(comment: String, src: String, pos: Position, site: Global.Symbol = NoSymbol): Comment
Parses a raw comment string into a
Commentobject.Parses a raw comment string into a
Commentobject.- 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
- def parseWiki(string: String, pos: Position, inTpl: (CommentFactory.this)#DocTemplateImpl): Body
Parses a string containing wiki syntax into a
Commentobject.Parses a string containing wiki syntax into a
Commentobject. 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
endOfLineis used to mark line endings.
- def parseWikiAtSymbol(string: String, pos: Position, site: Global.Symbol): Body
Parses a string containing wiki syntax into a
Commentobject.Parses a string containing wiki syntax into a
Commentobject. 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
endOfLineis used to mark line endings.
- Definition Classes
- CommentFactoryBase
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from CommentFactory toStringFormat[CommentFactory] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (CommentFactory, B)
- Implicit
- This member is added by an implicit conversion from CommentFactory toArrowAssoc[CommentFactory] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
The Scala compiler and reflection APIs.