scala3-compiler-bootstrapped
API
Generated with
Copyright (c) 2002-2023, LAMP/EPFL
Copyright (c) 2002-2023, LAMP/EPFL
scala3-compiler-bootstrapped/dotty.tools/dotty.tools.dotc/dotty.tools.dotc.util/ParsedComment

ParsedComment

dotty.tools.dotc.util.ParsedComment
See theParsedComment companion object
class ParsedComment(val comment: Comment)

A parsed doc comment.

Value parameters

comment

The doc comment to parse

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

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

The @param section corresponding to name.

The @param section corresponding to name.

Value parameters

name

The parameter name whose documentation to extract.

Attributes

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.

Attributes

Concrete fields

val content: String

The content of this comment, after expansion if possible.

The content of this comment, after expansion if possible.

Attributes

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.

Attributes

Generated with
Copyright (c) 2002-2023, LAMP/EPFL
Copyright (c) 2002-2023, LAMP/EPFL