class

Jasper::DocDocument

Inherits JSON::Serializable < YAML::Serializable < Reference < Object

Constructors

new(id : String, title : String, summary : String, track : String | Nil = nil, root_module : String | Nil = nil, parent_module : String | Nil = nil, overview : String | Nil = nil, related_sources : Array(String) | Nil = nil, sections : Array(DocSection) = [] of DocSection)
Source
new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
Source
new(pull : JSON::PullParser)
Source
new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

full_module_name(default_root : String = "Docs") : String
Source
id=(id : String)
Source
overview
Source
overview=(overview : String | Nil)
Source
parent_module
Source
parent_module=(parent_module : String | Nil)
Source
related_sources
Source
related_sources=(related_sources : Array(String) | Nil)
Source
resolved_parent_module(default_root : String = "Docs") : String
Source
root_module
Source
root_module=(root_module : String | Nil)
Source
sections
Source
sections=(sections : Array(DocSection))
Source
summary
Source
summary=(summary : String)
Source
title
Source
title=(title : String)
Source
track
Source
track=(track : String | Nil)
Source