Comment

dotty.tools.dotc.core.Comments$.Comment
See theComment companion object
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 parameters

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.

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

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 parameters

f

The expansion function.

Attributes

Returns

The expanded comment, with the usecases populated.

Has this comment been cooked or expanded?

Has this comment been cooked or expanded?

Attributes

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product

Concrete fields

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.

Attributes