Class/Module Index [+]

Quicksearch

YARD::Templates::Helpers::ModuleHelper

Helper methods for managing module objects.

Public Instance Methods

prune_method_listing(list, hide_attributes = true) click to toggle source

Prunes the method listing by running the verifier and removing attributes/aliases @param [Array<CodeObjects::Base>] list a list of methods @param [Boolean] hide_attributes whether to prune attribute methods from the list @return [Array<CodeObjects::Base>] a pruned list of methods

# File lib/yard/templates/helpers/module_helper.rb, line 10
def prune_method_listing(list, hide_attributes = true)
  list = run_verifier(list)
  list = list.reject {|o| o.is_alias? unless CodeObjects::Proxy === o.namespace }
  list = list.reject {|o| o.is_attribute? unless CodeObjects::Proxy === o.namespace } if hide_attributes
  list
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.