kit-doc
kit-doc

edge

kit-doc edge

Modules module
Kit::Doc::Services::Modules
View Source

Logic used in Yard to retrieve objects or properties, centralized in one place.

Link to this section Summary ⚠️ Private APIs are currently hidden.

Defined in: lib/kit/doc/services/modules.rb#2

Class methods 17

.get_all_constants_as_list(options:, verifier_runner:)

Get all constants declared in `object` namespace as an array.
.get_all_methods_as_list(options:, verifier_runner:)

Get all methods of `object` as an array.
.get_all_namespaces_as_hash(options:, verifier_runner:)

Get all Classes & Modules as a hash, the key being the fully qualified name of the object.
.get_all_namespaces_as_list(options:, verifier_runner:)

Get all Classes & Modules as an array.
.get_object_attributes(object:, options:, verifier_runner:)

Get all attributes of `object`.
.get_object_classes(object:, options:, verifier_runner:)

Get all classes declared in `object` namespace.
.get_object_constants(object:, options:, verifier_runner:, include_inherited: false)

Get all constants declared in `object` namespace as a hash.
.get_object_extended_into(object:, verifier_runner:, globals:)

Get the class / modules that have extended `object`.
.get_object_included_into(object:, verifier_runner:, globals:)

Get the class / modules that have included `object`.
.get_object_inherited_attributes(object:, options:, verifier_runner:)

Get all attributes inherited by `object`.
.get_object_inherited_constants(object:, options:, verifier_runner:)

Get all constants declared in parent's `object` namespace.
.get_object_inherited_methods(object:, options:, verifier_runner:, include_instance_methods: true, include_class_methods: true, hide_if_overwritten: true)

Get all methods inherited by `object`.
.get_object_methods(object:, options:, verifier_runner:, include_aliases: true, include_attributes: false, include_inherited: false, include_specials: true, include_instance_methods: true, include_class_methods: true)

Get all methods of `object` as an hash.
.get_object_mixins_extend(object:, verifier_runner:)

Get the class / modules that have been extended into `object`.
.get_object_mixins_include(object:, verifier_runner:)

Get the class / modules that have been included into `object`.
.get_object_modules(object:, options:, verifier_runner:)

Get all Modules.
.get_object_subclasses(object:, options:, verifier_runner:, globals:)

Get all subclasses of `object`.

Link to this section Class methods 17

Link to this method

.get_all_constants_as_list(options:, verifier_runner:)

View Source

Get all constants declared in object namespace as an array.

Link to this method

.get_all_methods_as_list(options:, verifier_runner:)

View Source

Get all methods of object as an array.

Link to this method

.get_all_namespaces_as_hash(options:, verifier_runner:)

View Source

Get all Classes & Modules as a hash, the key being the fully qualified name of the object.

Link to this method

.get_all_namespaces_as_list(options:, verifier_runner:)

View Source

Get all Classes & Modules as an array.

Link to this method

.get_object_attributes(object:, options:, verifier_runner:)

View Source

Get all attributes of object.

Link to this method

.get_object_classes(object:, options:, verifier_runner:)

View Source

Get all classes declared in object namespace.

References

Link to this method

.get_object_constants(object:, options:, verifier_runner:, include_inherited: false)

View Source

Get all constants declared in object namespace as a hash.

Link to this method

.get_object_extended_into(object:, verifier_runner:, globals:)

View Source

Get the class / modules that have extended object.

References

Link to this method

.get_object_included_into(object:, verifier_runner:, globals:)

View Source

Get the class / modules that have included object.

References

Link to this method

.get_object_inherited_attributes(object:, options:, verifier_runner:)

View Source

Get all attributes inherited by object.

Link to this method

.get_object_inherited_constants(object:, options:, verifier_runner:)

View Source

Get all constants declared in parent's object namespace.

Link to this method

.get_object_inherited_methods(object:, options:, verifier_runner:, include_instance_methods: true, include_class_methods: true, hide_if_overwritten: true)

View Source

Get all methods inherited by object.

Link to this method

.get_object_methods(object:, options:, verifier_runner:, include_aliases: true, include_attributes: false, include_inherited: false, include_specials: true, include_instance_methods: true, include_class_methods: true)

View Source

Get all methods of object as an hash.

Link to this method

.get_object_mixins_extend(object:, verifier_runner:)

View Source

Get the class / modules that have been extended into object.

Link to this method

.get_object_mixins_include(object:, verifier_runner:)

View Source

Get the class / modules that have been included into object.

Link to this method

.get_object_modules(object:, options:, verifier_runner:)

View Source

Get all Modules.

References

Link to this method

.get_object_subclasses(object:, options:, verifier_runner:, globals:)

View Source

Get all subclasses of object.

References