scala3-compiler-bootstrapped/dotty.tools.dotc.util/ParsedComment

ParsedComment

class ParsedComment(val comment: Comment)

A parsed doc comment.

A parsed doc comment.

Value Params
comment

The doc comment to parse

Companion
object
class Object
trait Matchable
class Any

Value members

Concrete methods

def paramDoc(name: TermName): Option[String]

The @param section corresponding to name.

The @param section corresponding to name.

Value Params
name

The parameter name whose documentation to extract.

Returns

The formatted documentation corresponding to name.

def renderAsMarkdown(using Context): String

Renders this comment as markdown.

Renders this comment as markdown.

The different sections are formatted according to the mapping in knownTags.

Concrete fields

val content: String

The content of this comment, after expansion if possible.

The content of this comment, after expansion if possible.

lazy val mainDoc: String

The "main" documentation for this comment. That is, the comment before any section starts.

The "main" documentation for this comment. That is, the comment before any section starts.