scala.tools.nsc.doc.model.comment

CommentFactory

trait CommentFactory 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
ModelFactory with CommentFactory
Source
CommentFactory.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. CommentFactory
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Type Members

  1. class CharReader extends AnyRef

    Attributes
    protected sealed

  2. case class SimpleTagKey (name: String) extends TagKey with Product with Serializable

    Attributes
    protected final

  3. case class SymbolTagKey (name: String, symbol: String) extends TagKey with Product with Serializable

    Attributes
    protected final

  4. class TagKey extends AnyRef

    A key used for a tag map.

  5. class WikiParser extends CharReader

    TODO

Abstract Value Members

  1. val global : Global

    Attributes
    abstract

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

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

  7. val CodeBlockEnd : Regex

    The end of a scaladoc code block

    The end of a scaladoc code block

    Attributes
    protected

  8. val CodeBlockStart : Regex

    The start of a scaladoc code block

    The start of a scaladoc code block

    Attributes
    protected

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

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

  11. val SafeTags : Regex

    Safe HTML tags that can be kept.

    Safe HTML tags that can be kept.

    Attributes
    protected

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

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

  14. def addCommentBody (sym: Symbol, inTpl: ⇒ TemplateImpl, docStr: String, docPos: Position): Symbol

  15. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  16. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  17. def comment (sym: Symbol, inTpl: ⇒ DocTemplateImpl): Option[Comment]

  18. val commentCache : HashMap[(Symbol, TemplateImpl), Comment]

    Attributes
    protected

  19. 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): Comment

  20. def defineComment (sym: Symbol, inTpl: ⇒ 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 This function manages some of those cases : Param accessor and Primary constructor

  21. val endOfLine : Char

    Attributes
    protected

  22. val endOfText : Char

    Attributes
    protected

  23. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  24. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  25. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef → Any

  27. def hashCode (): Int

    Definition Classes
    AnyRef → Any

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

  29. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

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

  31. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  32. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  33. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

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

  35. def parse (comment: String, src: String, pos: Position): 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

  36. def parseWiki (string: String, pos: Position): 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.

  37. val safeTagMarker : Char

    Attributes
    protected

  38. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  39. def toString (): String

    Definition Classes
    AnyRef → Any

  40. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  41. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  42. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any