abstract class Redoc::Type

• Redoc::Type
• Reference
• Object

Overview

Represents all types in a Crystal library. This is mainly used internally in Redoc for transformation and type resolution.

Included Modules

• JSON::Serializable

Direct Known Subclasses

• Redoc::Alias
• Redoc::Annotation
• Redoc::Class
• Redoc::Const
• Redoc::Def
• Redoc::Enum
• Redoc::Macro
• Redoc::Module
• Redoc::Struct

Defined in:

redoc/types.cr

Constructors

• .new(pull : JSON::PullParser)

Instance Method Summary

• #doc : String | Nil
• #doc=(doc : String | Nil)
• #summary : String | Nil
• #summary=(summary : String | Nil)
• #top_level=(top_level : Bool)

  Whether the type is defined in the top-level namespace.

• #top_level? : Bool

  Whether the type is defined in the top-level namespace.

Constructor Detail

Instance Method Detail