Class YARD::Generators::ConstantsGenerator
In: lib/yard/generators/constants_generator.rb
Parent: Base

Methods

has_constants?   has_included_constants?   has_inherited_constants?   included_constants_by_module   inherited_constants_by_class   sections_for  

Public Instance methods

Protected Instance methods

included_constants_by_module() {|superclass, consts| ...}

@yield [module, constlist] 

  Yields a the list of methods pertaining to a module
  in the module order.

@yieldparam [CodeObjects::ModuleObject] module 

  The module the constants belong to

@yieldparam [Array<CodeObjects::ConstantObject>] consts 

  The list of constants included from the module
inherited_constants_by_class() {|superclass, consts| ...}

@yield a the list of methods pertaining to a superclass 

  in the inheritance order.

@yieldparam [CodeObjects::ClassObject] superclass 

  The superclass the constants belong to

@yieldparam [Array<CodeObjects::ConstantObject>] consts 

  The list of constants inherited from the superclass

[Validate]