method

remove_from_documentation?

v2_1_10 - Show latest stable - 0 notes - Class: RDoc::Context

1_8_6_287
1_8_7_72
1_8_7_330
1_9_1_378
1_9_2_180
1_9_3_125 (0)
1_9_3_392 (0)
2_1_10 (0)
2_2_9 (0)
2_4_6 (0)
2_5_5 (0)
2_6_3 (0)
What's this?

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 #remove_from_documentation? == true
All classes and modules have #remove_from_documentation? == true

Show source

# File lib/rdoc/context.rb, line 1049
  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