class
Crystal::Doc::Type
Included Modules
Defined in:
compiler/crystal/tools/doc/type.crConstant Summary
-
PSEUDO_CLASS_NOTE =
"\nNOTE: This is a pseudo-class provided directly by the Crystal compiler.\nIt cannot be reopened nor overridden." -
PSEUDO_CLASS_PREFIX =
"CRYSTAL_PSEUDO__"
Constructors
Instance Method Summary
- #abstract?
- #alias?
- #alias_definition
- #all_class_methods
- #ancestors
- #annotations(annotation_type)
- #ast_node?
- #class_methods
- #const?
- #constants
- #constructors
- #current?(type)
- #dir
- #doc
- #enum?
- #extended_modules
- #external_vars
- #formatted_alias_definition
- #formatted_type_definition
- #full_name(io)
- #full_name
- #full_name_without_type_vars(io)
- #full_name_without_type_vars
- #fun_def?
- #functions
- #html_id
- #included_modules
- #including_types
- #inspect(*args, **options)
- #inspect(*args, **options, &)
- #instance_methods
- #kind
- #lib?
- #link_from(type : Type)
- #locations
- #lookup_class_method(name, args_size)
- #lookup_class_method(name)
- #lookup_macro(name, args_size)
- #lookup_macro(name)
- #lookup_method(name, args_size)
- #lookup_method(name)
- #lookup_path(path_or_names : Path | Array(String))
- #lookup_path(full_path : String)
- #macro(a_macro)
- #macros
- #method(a_def, class_method)
- #must_be_included?
- #name
- #namespace
- #nesting
- #nil_type?(node : ASTNode)
- #node_to_html(node : Path, io, html : HTMLOption = :all)
- #node_to_html(node : Generic, io, html : HTMLOption = :all)
- #node_to_html(node : ProcNotation, io, html : HTMLOption = :all)
- #node_to_html(node : Union, io, html : HTMLOption = :all)
- #node_to_html(node : Underscore, io, html : HTMLOption = :all)
- #node_to_html(node, io, html : HTMLOption = :all)
- #node_to_html(node)
- #parents_of?(type)
- #path
- #path_from(type)
- #path_to(filename : String)
- #path_to(type : Type)
- #program
- #program?
- #subclasses
- #superclass
- #superclass_hierarchy
- #to_json(builder : JSON::Builder)
- #to_json_simple(builder : JSON::Builder)
-
#to_s(io : IO) : Nil
Appends a short String representation of this object which includes its class name and its object address.
- #to_s(*args, **options)
- #to_s(*args, **options, &)
- #type : Crystal::Type
- #type_def?
- #type_definition
- #type_has_link?(type : Crystal::UnionType)
- #type_has_link?(type : Crystal::ProcInstanceType)
- #type_has_link?(type : Crystal::TupleInstanceType)
- #type_has_link?(type : Crystal::NamedTupleInstanceType)
- #type_has_link?(type : Crystal::GenericInstanceType)
- #type_has_link?(type : Crystal::Type)
- #type_has_link?(type : Crystal::TypeParameter | ASTNode)
- #type_to_html(type : Crystal::UnionType, io, text = nil, html : HTMLOption = :all)
- #type_to_html(type : Crystal::ProcInstanceType, io, text = nil, html : HTMLOption = :all)
- #type_to_html(type : Crystal::TupleInstanceType, io, text = nil, html : HTMLOption = :all)
- #type_to_html(type : Crystal::NamedTupleInstanceType, io, text = nil, html : HTMLOption = :all)
- #type_to_html(type : Crystal::GenericInstanceType, io, text = nil, html : HTMLOption = :all)
- #type_to_html(type : Crystal::VirtualType, io, text = nil, html : HTMLOption = :all)
- #type_to_html(type : Crystal::Type, io, text = nil, html : HTMLOption = :all)
- #type_to_html(type : Type, io, text = nil, html : HTMLOption = :all)
- #type_to_html(type : ASTNode, io, text = nil, html : HTMLOption = :all)
- #type_to_html(type)
- #type_vars
- #types
- #visibility
Instance methods inherited from module Crystal::Doc::Item
formatted_doc
formatted_doc,
formatted_summary
formatted_summary
Instance methods inherited from class Reference
==(other : self)==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, initialize initialize, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference) : Bool
same?(other : Nil) same?, to_s(io : IO) : Nil to_s
Constructor methods inherited from class Reference
new
new,
unsafe_construct(address : Pointer, *args, **opts) : self
unsafe_construct
Class methods inherited from class Reference
pre_initialize(address : Pointer)
pre_initialize
Instance methods inherited from class Object
! : Bool
!,
!=(other)
!=,
!~(other)
!~,
==(other)
==,
===(other : JSON::Any)===(other : YAML::Any)
===(other) ===, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, inspect(io : IO) : Nil
inspect : String inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil!(message)
not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as
Class methods inherited from class Object
from_json(string_or_io : String | IO, root : String)from_json(string_or_io : String | IO) from_json, from_yaml(string_or_io : String | IO) from_yaml
Macros inherited from class Object
class_getter(*names, &block)
class_getter,
class_getter!(*names)
class_getter!,
class_getter?(*names, &block)
class_getter?,
class_property(*names, &block)
class_property,
class_property!(*names)
class_property!,
class_property?(*names, &block)
class_property?,
class_setter(*names)
class_setter,
def_clone
def_clone,
def_equals(*fields)
def_equals,
def_equals_and_hash(*fields)
def_equals_and_hash,
def_hash(*fields)
def_hash,
delegate(*methods, to object)
delegate,
forward_missing_to(delegate)
forward_missing_to,
getter(*names, &block)
getter,
getter!(*names)
getter!,
getter?(*names, &block)
getter?,
property(*names, &block)
property,
property!(*names)
property!,
property?(*names, &block)
property?,
setter(*names)
setter
Constructor Detail
Instance Method Detail
Description copied from class Reference
Appends a short String representation of this object which includes its class name and its object address.
class Person
def initialize(@name : String, @age : Int32)
end
end
Person.new("John", 32).to_s # => #<Person:0x10a199f20>
def type_to_html(type : Crystal::NamedTupleInstanceType, io, text = nil, html : HTMLOption = :all)
#