scala3-compiler-bootstrapped/dotty.tools.dotc.core/Comments/Comment

Comment

final case class Comment(span: Span, raw: String, expanded: Option[String], usecases: List[UseCase], variables: Map[String, String])

A Comment contains the unformatted docstring, it's position and potentially more information that is populated when the comment is "cooked".

Value Params
expanded

If this comment has been expanded, it's expansion, otherwise None.

raw

The raw comment, as seen in the source code, without any expansion.

span

The position span of this Comment.

usecases

The usecases for this comment.

Companion
object
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def expand(f: String => String)(using Context): Comment

Expands this comment by giving its content to f, and then parsing the @usecase sections. Typically, f will take care of expanding the variables.

Expands this comment by giving its content to f, and then parsing the @usecase sections. Typically, f will take care of expanding the variables.

Value Params
f

The expansion function.

Returns

The expanded comment, with the usecases populated.

def isExpanded: Boolean

Has this comment been cooked or expanded?

Has this comment been cooked or expanded?

Inherited methods

def productIterator: Iterator[Any]
Inherited from
Product

Concrete fields

lazy val expandedBody: Option[String]

The body of this comment, without the @usecase and @define sections, after expansion.

The body of this comment, without the @usecase and @define sections, after expansion.