CommentFactory

Type Members

sealed class CharReader extends AnyRef

Attributes
protected
final case class SimpleTagKey(name: String) extends (CommentFactory.this)#TagKey with Product with Serializable

Attributes
protected
final case class SymbolTagKey(name: String, symbol: String) extends (CommentFactory.this)#TagKey with Product with Serializable

Attributes
protected
sealed abstract class TagKey extends AnyRef

A key used for a tag map.
final class WikiParser extends (CommentFactory.this)#CharReader

TODO

Abstract Value Members

abstract val global: Global

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
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
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()
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
val CleanCommentLine: Regex

The body of a line, dropping the (optional) start star-marker, one leading whitespace and all trailing whitespace.
The body of a line, dropping the (optional) start star-marker, one leading whitespace and all trailing whitespace.

Attributes
protected
val CodeBlockEnd: Regex

The end of a scaladoc code block
The end of a scaladoc code block

Attributes
protected
val CodeBlockStart: Regex

The start of a scaladoc code block
The start of a scaladoc code block

Attributes
protected
val DangerousTags: Regex

Dangerous HTML tags that should be replaced by something safer, such as wiki syntax, or that should be dropped.
Dangerous HTML tags that should be replaced by something safer, such as wiki syntax, or that should be dropped.

Attributes
protected
val JavadocTags: Regex

Javadoc tags that should be replaced by something useful, such as wiki syntax, or that should be dropped.
Javadoc tags that should be replaced by something useful, such as wiki syntax, or that should be dropped.

Attributes
protected
val SafeTags: Regex

Safe HTML tags that can be kept.
Safe HTML tags that can be kept.

Attributes
protected
val SimpleTag: Regex

A Scaladoc tag not linked to a symbol.
A Scaladoc tag not linked to a symbol. Returns the name of the tag, and the rest of the line.

Attributes
protected
val SingleTag: Regex

A Scaladoc tag not linked to a symbol and not followed by text
A Scaladoc tag not linked to a symbol and not followed by text

Attributes
protected
val SymbolTag: Regex

A Scaladoc tag linked to a symbol.
A Scaladoc tag linked to a symbol. Returns the name of the tag, the name of the symbol, and the rest of the line.

Attributes
protected
def addCommentBody(sym: Global.Symbol, inTpl: (CommentFactory.this)#TemplateImpl, docStr: String, docPos: Global.Position): Global.Symbol
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
def comment(sym: Global.Symbol, currentTpl: Option[(CommentFactory.this)#DocTemplateImpl], inTpl: (CommentFactory.this)#DocTemplateImpl): Option[Comment]
val commentCache: HashMap[(Global.Symbol, (CommentFactory.this)#TemplateImpl), 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): Comment
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
val endOfLine: Char

Attributes
protected
val endOfText: Char

Attributes
protected
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
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
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
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
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()
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()
final def getClass(): java.lang.Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def htmlReplacement(mtch: Match): String

Maps a dangerous HTML tag to a safe wiki replacement, or an empty string if it cannot be salvaged.
Maps a dangerous HTML tag to a safe wiki replacement, or an empty string if it cannot be salvaged.

Attributes
protected
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def javadocReplacement(mtch: Match): String

Maps a javadoc tag to a useful wiki replacement, or an empty string if it cannot be salvaged.
Maps a javadoc tag to a useful wiki replacement, or an empty string if it cannot be salvaged.

Attributes
protected
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def oops(msg: String): Nothing

Something that should not have happened, happened, and Scaladoc should exit.
Something that should not have happened, happened, and Scaladoc should exit.

Attributes
protected
def parse(comment: String, src: String, pos: Position, inTplOpt: Option[(CommentFactory.this)#DocTemplateImpl] = 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
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.
val safeTagMarker: Char

Attributes
protected
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): (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 Implict Value Members

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

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

trait CommentFactory extends AnyRef

Type Members

sealed class CharReader extends AnyRef

final case class SimpleTagKey(name: String) extends (CommentFactory.this)#TagKey with Product with Serializable

final case class SymbolTagKey(name: String, symbol: String) extends (CommentFactory.this)#TagKey with Product with Serializable

sealed abstract class TagKey extends AnyRef

final class WikiParser extends (CommentFactory.this)#CharReader

Abstract Value Members

abstract val global: Global

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

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

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

val CleanCommentLine: Regex

val CodeBlockEnd: Regex

val CodeBlockStart: Regex

val DangerousTags: Regex

val JavadocTags: Regex

val SafeTags: Regex

val SimpleTag: Regex

val SingleTag: Regex

val SymbolTag: Regex

def addCommentBody(sym: Global.Symbol, inTpl: (CommentFactory.this)#TemplateImpl, docStr: String, docPos: Global.Position): Global.Symbol

final def asInstanceOf[T0]: T0

def clone(): AnyRef

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

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

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

val endOfLine: Char

val endOfText: Char

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

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

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

def ensuring(cond: Boolean): CommentFactory

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

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

def hashCode(): Int

def htmlReplacement(mtch: Match): String

final def isInstanceOf[T0]: Boolean

def javadocReplacement(mtch: Match): String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def oops(msg: String): Nothing

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

def parseWiki(string: String, pos: Position, inTplOpt: Option[(CommentFactory.this)#DocTemplateImpl]): Body

val safeTagMarker: Char

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

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

Shadowed Implict Value Members

val self: Any

val self: Any

Deprecated Value Members

def x: CommentFactory

def x: CommentFactory

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