trait CommentParser
extends MemberLookup

Constructors

Members

private final case class SimpleTagKey
private final object SimpleTagKey
private final case class SymbolTagKey
private final object SymbolTagKey
private sealed abstract class TagKey

A key used for a tag map. The key is built from the name of the tag and from the linked symbol if the tag has one. Equality on tag keys is structural.

A key used for a tag map. The key is built from the name of the tag and from the linked symbol if the tag has one. Equality on tag keys is structural.

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

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

Parses a raw comment string into a Comment object.

Parses a raw comment string into a Comment object.

def parse$default$6 : NoSymbol.type

Parses a raw comment string into a Comment object.

Parses a raw comment string into a Comment object.

[+] 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. Note that the string is assumed to be clean: - Removed Scaladoc start and end markers. - Re...

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.