struct ActionController::OpenAPI::KlassDoc

• ActionController::OpenAPI::KlassDoc
• Struct
• Value
• Object

Overview

this is used to hold class and method documentation for generating OpenAPI documentation

Included Modules

• JSON::Serializable
• YAML::Serializable

Extended Modules

• JSON::Schema

Defined in:

action-controller/open_api/klass_doc.cr

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(name : String, docs : String | Nil)
• .new(pull : JSON::PullParser)

Instance Method Summary

• #ancestors : Array(String)
• #docs : String | Nil
• #implements?(filter)
• #methods : Hash(String, String)
• #name : String

Constructor Detail

Instance Method Detail