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

Comments

object Comments
class Object
trait Matchable
class Any

Type members

Classlikes

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

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
object Comment
Companion
class
class CommentExpander

Port of DocComment.scala from nsc

Port of DocComment.scala from nsc

Authors

Martin Odersky

Felix Mulder

class ContextDocstrings

Context for Docstrings, contains basic functionality for getting docstrings via Symbol and expanding templates

Context for Docstrings, contains basic functionality for getting docstrings via Symbol and expanding templates

final case class UseCase(code: String, codePos: Span, untpdCode: Tree, tpdCode: Option[DefDef])
Companion
object
object UseCase
Companion
class

Value members

Concrete fields

Givens

Givens

given CommentsContext

Decorator for getting docbase out of context

Decorator for getting docbase out of context