class

Myst::DocComment

Inherits Myst::Node / Reference / Object

A full documentation comment. Documentation comments are distinct entities that automatically attach to whatever expression follows them. Doc comments are available at runtime by inspecting values, or can be parsed out statically. In the AST, DocComment nodes wrap around whatever their target expression is so that the target expression can be interpreted consistently.

'#doc' [ content ] [ '#|' content ]* target

Constructors

new(header : String | Nil, content : String, target : Node)
Source

Instance methods

==(other : self)

Returns true if this reference is the same as other. Invokes same?.

content
Source
content=(content : String)
Source
hash(hasher)

See Object#hash(hasher)

header
Source
header=(header : String | Nil)
Source
target
Source
target=(target : Node)
Source