Method: YARD::CodeObjects::NamespaceObject#constants

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

#constants(opts = {}) ⇒ Array<ConstantObject>

Returns all constants in the namespace

Parameters:

  • opts (Hash) (defaults to: {})

    a customizable set of options

Options Hash (opts):

  • :included (Boolean) — default: true

    whether or not to include mixed in constants in list

Returns:


164
165
166
167
168
# File 'lib/yard/code_objects/namespace_object.rb', line 164

def constants(opts = {})
  opts = SymbolHash[:included => true].update(opts)
  consts = children.select {|o| o.is_a? ConstantObject }
  consts + (opts[:included] ? included_constants : [])
end