trait CommentFactoryBase extends AnyRef
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
- CommentFactoryBase with MemberLookupBase
- Source
- CommentFactoryBase.scala
- Alphabetic
- By Inheritance
- CommentFactoryBase
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Type Members
-
sealed
class
CharReader
extends AnyRef
- Attributes
- protected
-
final
class
WikiParser
extends (CommentFactoryBase.this)#CharReader
TODO
TODO
- Attributes
- protected
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 CommentFactoryBase to any2stringadd[CommentFactoryBase] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (CommentFactoryBase, B)
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to ArrowAssoc[CommentFactoryBase] 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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- 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
-
def
ensuring(cond: (CommentFactoryBase) ⇒ Boolean, msg: ⇒ Any): CommentFactoryBase
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to Ensuring[CommentFactoryBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (CommentFactoryBase) ⇒ Boolean): CommentFactoryBase
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to Ensuring[CommentFactoryBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): CommentFactoryBase
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to Ensuring[CommentFactoryBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): CommentFactoryBase
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to Ensuring[CommentFactoryBase] performed by method Ensuring 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
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to StringFormat[CommentFactoryBase] performed by method StringFormat 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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
parseAtSymbol(comment: String, src: String, pos: Position, site: Global.Symbol = NoSymbol): 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
-
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.
-
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( ... )
-
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): (CommentFactoryBase, B)
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to ArrowAssoc[CommentFactoryBase] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Inherited from AnyRef
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
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( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Inherited from Any
Inherited by implicit conversion any2stringadd from CommentFactoryBase to any2stringadd[CommentFactoryBase]
Value Members
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to any2stringadd[CommentFactoryBase] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
Inherited by implicit conversion StringFormat from CommentFactoryBase to StringFormat[CommentFactoryBase]
Value Members
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to StringFormat[CommentFactoryBase] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
Inherited by implicit conversion Ensuring from CommentFactoryBase to Ensuring[CommentFactoryBase]
Value Members
-
def
ensuring(cond: (CommentFactoryBase) ⇒ Boolean, msg: ⇒ Any): CommentFactoryBase
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to Ensuring[CommentFactoryBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (CommentFactoryBase) ⇒ Boolean): CommentFactoryBase
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to Ensuring[CommentFactoryBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): CommentFactoryBase
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to Ensuring[CommentFactoryBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): CommentFactoryBase
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to Ensuring[CommentFactoryBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
Inherited by implicit conversion ArrowAssoc from CommentFactoryBase to ArrowAssoc[CommentFactoryBase]
Value Members
-
def
->[B](y: B): (CommentFactoryBase, B)
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to ArrowAssoc[CommentFactoryBase] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
def
→[B](y: B): (CommentFactoryBase, B)
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to ArrowAssoc[CommentFactoryBase] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Ungrouped
-
sealed
class
CharReader
extends AnyRef
- Attributes
- protected
-
final
class
WikiParser
extends (CommentFactoryBase.this)#CharReader
TODO
TODO
- Attributes
- protected
- abstract val global: Global
-
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 CommentFactoryBase to any2stringadd[CommentFactoryBase] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (CommentFactoryBase, B)
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to ArrowAssoc[CommentFactoryBase] 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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- 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
-
def
ensuring(cond: (CommentFactoryBase) ⇒ Boolean, msg: ⇒ Any): CommentFactoryBase
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to Ensuring[CommentFactoryBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (CommentFactoryBase) ⇒ Boolean): CommentFactoryBase
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to Ensuring[CommentFactoryBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): CommentFactoryBase
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to Ensuring[CommentFactoryBase] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): CommentFactoryBase
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to Ensuring[CommentFactoryBase] performed by method Ensuring 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
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to StringFormat[CommentFactoryBase] performed by method StringFormat 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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
parseAtSymbol(comment: String, src: String, pos: Position, site: Global.Symbol = NoSymbol): 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
-
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.
-
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( ... )
-
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): (CommentFactoryBase, B)
- Implicit
- This member is added by an implicit conversion from CommentFactoryBase to ArrowAssoc[CommentFactoryBase] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
The Scala compiler and reflection APIs.