Method: YARD::CodeObjects::ModuleObject#inheritance_tree

Defined in:
lib/yard/code_objects/module_object.rb

#inheritance_tree(include_mods = false) ⇒ Array<NamespaceObject>

Returns the inheritance tree of mixins.

Parameters:

  • include_mods (Boolean) (defaults to: false) —

    if true, will include mixed in modules (which is likely what is wanted).

Returns:


9
10
11
12
13
14
15
16
 
# File 'lib/yard/code_objects/module_object.rb', line 9

def inheritance_tree(include_mods = false)
  return [self] unless include_mods
  [self] + mixins(:instance, :class).map do |m|
    next if m == self
    next m unless m.respond_to?(:inheritance_tree)
    m.inheritance_tree(true)
  end.compact.flatten.uniq
end