class Myst::DocComment

Overview

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

Defined in:

myst/syntax/ast.cr

Constructors

Instance Method Summary

Instance methods inherited from class Myst::Node

accept(visitor) accept, accept_children(visitor) accept_children, at(node : Node)
at(node : Nil)
at(location : Location) at, at_end(node : Node)
at_end(node : Nil)
at_end(end_location : Location) at_end, class_desc : String class_desc, end_location : Location | Nil end_location, end_location=(end_location : Location | Nil) end_location=, location : Location | Nil location, location=(location : Location | Nil) location=

Constructor Detail

def self.new(header : String | Nil, content : String, target : Node) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

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


def content : String #

[View source]
def content=(content : String) #

[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def header : String | Nil #

[View source]
def header=(header : String | Nil) #

[View source]
def target : Node #

[View source]
def target=(target : Node) #

[View source]