CommentFactory

abstract val global: Global

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

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

val CodeBlockEnd: Regex

The end of a scaladoc code block

val CodeBlockStart: Regex

The start of a scaladoc code block

val DangerousTags: Regex

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

val JavadocTags: Regex

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

val SafeTags: Regex

Safe HTML tags that can be kept.

val SimpleTag: Regex

A Scaladoc tag not linked to a symbol.

val SingleTag: Regex

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

val SymbolTag: Regex

A Scaladoc tag linked to a symbol.

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

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

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

final def isInstanceOf[T0]: Boolean

def javadocReplacement(mtch: Match): String

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def oops(msg: String): Nothing

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

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

def parseAtSymbol(comment: String, src: String, pos: Position, siteOpt: Option[Global.Symbol] = None): Comment

Parses a raw comment string into a Comment object.

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

Parses a string containing wiki syntax into a Comment object.

def parseWikiAtSymbol(string: String, pos: Position, siteOpt: Option[Global.Symbol]): Body

Parses a string containing wiki syntax into a Comment object.

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)

val self: Any

val self: Any

def x: CommentFactory

def x: CommentFactory