method

remove_from_documentation?

v1_9_3_125 - Show latest stable - Class: RDoc::Context

remove_from_documentation?()

public

Should we remove this context from the documentation?

The answer is yes if:

#received_nodoc is true
#any_content is false (not counting includes)
All #includes are modules (not a string), and their module has

<tt>#remove_from_documentation? == true</tt>

All classes and modules have #remove_from_documentation? == true

# File lib/rdoc/context.rb, line 1079
  def remove_from_documentation?
    @remove_from_documentation ||=
      @received_nodoc &&
      !any_content(false) &&
      @includes.all? { |i| !i.module.is_a?(String) && i.module.remove_from_documentation? } &&
      classes_and_modules.all? { |cm| cm.remove_from_documentation? }
  end

remove_from_documentation?

Related methods