class
Crystal::Doc::Method
Included Modules
Defined in:
compiler/crystal/tools/doc/method.crConstant Summary
-
PSEUDO_METHOD_NOTE =
"\nNOTE: This is a pseudo-method provided directly by the Crystal compiler.\nIt cannot be redefined nor overridden." -
PSEUDO_METHOD_PREFIX =
"__crystal_pseudo_"
Constructors
Instance Method Summary
- #abstract?
- #anchor
- #annotations(annotation_type)
- #arg_to_html(arg : Arg, io, html : HTMLOption = :all)
- #args
- #args_to_html(html : HTMLOption = :all)
- #args_to_html(io : IO, html : HTMLOption = :all) : Nil
- #args_to_s(io : IO) : Nil
- #args_to_s
- #constructor?
- #def : Def
-
#doc
Returns this method's docs ready to be shown (before formatting) in the UI.
-
#doc_copied_from : Type | Nil
Returns the type this method's docs are copied from, but only if this method has no docs at all.
- #external_var?
- #has_args?
- #html_id
- #id
- #kind
- #location
- #must_be_included?
- #name
- #node_to_html(node, io, html : HTMLOption = :all)
- #prefix
- #real_name
- #return_type
- #to_json(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.
- #type : Type
- #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
def doc
#
Returns this method's docs ready to be shown (before formatting)
in the UI. This includes copying docs from previous def or
ancestors and replacing :inherit: with the ancestor docs.
This docs not include the "Description copied from ..." banner
in case it's needed.
Returns the type this method's docs are copied from, but only if this method has no docs at all. In this case the docs will be copied from this type and a "Description copied from ..." will be added before the docs.
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>