Dotty Documentation

0.14.0-bin-SNAPSHOT

final case class Comment
extends Object with Product with Serializable

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

[-] Constructors

Comment ( span: Span , raw: String , expanded: Option [ String ] , usecases: List [ UseCase ] )

[-] Members

[+] val expanded : Option [ String ]
[+] lazy val expandedBody : Option [ String ]

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

[+] val isDocComment : Boolean
[+] val raw : String
[+] val span : Span
[+] val usecases : List [ UseCase ]
[+] def expand ( f: String => String ) ( implicit ctx: 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.

[+] def isExpanded : Boolean

Has this comment been cooked or expanded?