Comments

dotty.tools.dotc.core.Comments$
object Comments

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Comments.type

Members list

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 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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Comment

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Comment.type

Port of DocComment.scala from nsc

Port of DocComment.scala from nsc

Attributes

Authors:

Martin Odersky

Felix Mulder

Supertypes
class Object
trait Matchable
class Any

Decorator for getting docbase out of context

Decorator for getting docbase out of context

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type

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

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class UseCase(code: String, codePos: Span, untpdCode: Tree, tpdCode: Option[DefDef])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
UseCase.type

Value members

Concrete fields

Givens

Givens

Decorator for getting docbase out of context

Decorator for getting docbase out of context

Attributes