dotty.tools.dottydoc.model.comment

CommentParser

Related Doc: package comment

trait CommentParser extends MemberLookup

Linear Supertypes
MemberLookup, AnyRef, Any
Known Subclasses
DocstringPhase
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CommentParser
  2. MemberLookup
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. sealed class CharReader extends AnyRef

    Attributes
    protected

  2. case class FullComment(body: Body, authors: List[Body], see: List[Body], result: Option[Body], throws: Map[String, Body], valueParams: Map[String, Body], typeParams: Map[String, Body], version: Option[Body], since: Option[Body], todo: List[Body], deprecated: Option[Body], note: List[Body], example: List[Body], constructor: Option[Body], group: Option[Body], groupDesc: Map[String, Body], groupNames: Map[String, Body], groupPrio: Map[String, Body], hideImplicitConversions: List[Body], shortDescription: List[Body]) extends Product with Serializable

  3. final class WikiParser extends CharReader

    Original wikiparser from NSC

    Original wikiparser from NSC

    Attributes
    protected

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. def clone(): AnyRef

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

  6. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  12. def lookup(entity: Entity, packages: Map[String, Package], query: String, pos: Position): LinkTo

    Performs a lookup based on the provided (pruned) query string

    Performs a lookup based on the provided (pruned) query string

    Will return a Tooltip if unsucessfull, otherwise a LinkToEntity or LinkToExternal

    Definition Classes
    MemberLookup

  13. def makeEntityLink(entity: Entity, packages: Map[String, Package], title: Inline, pos: Position, query: String): EntityLink

    Definition Classes
    MemberLookup

  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  17. def parse(entity: Entity, packages: Map[String, Package], comment: List[String], src: String, pos: Position, site: Symbol = NoSymbol)(implicit ctx: Context): FullComment

    Parses a raw comment string into a Comment object.

    Parses a raw comment string into a Comment object.

    packages

    all packages parsed by Scaladoc tool, used for lookup

    src

    the raw comment source string.

    pos

    the position of the comment in source.

  18. def parseWikiAtSymbol(entity: Entity, packages: Map[String, Package], string: String, pos: Position, site: Symbol)(implicit ctx: Context): 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.

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

    Definition Classes
    AnyRef

  20. def toString(): String

    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from MemberLookup

Inherited from AnyRef

Inherited from Any

Ungrouped