class

Jasper::DocSection

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

Constructors

new(id : String, title : String, summary : String, type : String | Nil = nil, content : String | Nil = nil, options : Hash(String, String) | Nil = nil, examples : Array(String) | Nil = nil, pitfalls : Array(String) | Nil = nil, faqs : Array(Hash(String, String)) | Nil = nil, topics : Array(String) | Nil = nil, items : Array(String) | Nil = nil, return_value : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, custom_data : Hash(String, YAML::Any) | Nil = nil)
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

content
Source
content=(content : String | Nil)
Source
custom_data
Source
custom_data=(custom_data : Hash(String, YAML::Any) | Nil)
Source
examples
Source
examples=(examples : Array(String) | Nil)
Source
faqs
Source
faqs=(faqs : Array(Hash(String, String)) | Nil)
Source
id=(id : String)
Source
items
Source
items=(items : Array(String) | Nil)
Source
metadata
Source
metadata=(metadata : Hash(String, String) | Nil)
Source
options
Source
options=(options : Hash(String, String) | Nil)
Source
pitfalls
Source
pitfalls=(pitfalls : Array(String) | Nil)
Source
return_value
Source
return_value=(return_value : Array(String) | Nil)
Source
summary
Source
summary=(summary : String)
Source
title
Source
title=(title : String)
Source
topics
Source
topics=(topics : Array(String) | Nil)
Source
type
Source
type=(type : String | Nil)
Source