Login Register

remove_from_documentation?

remove_from_documentation?()

Instance Public methods

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

Links:

https://github.com/ruby/ruby/blob/854758c464e6cdba06eed5d05b7fe10c33788c89/lib/rdoc/context.rb#L1031

doc_ruby_on_rails

2015-05-01 20:05:36

Comments

Leave a Comment

Please login to continue.

Popular Articles

document document() Instance Public methods

documented? documented?() Instance Public methods A constant is documented if it has a comment, or is an alias for a documented class or module.

documented? documented?() Instance Public methods Does this object have a comment with content or is received_nodoc true?

$document service in module ng A jQuery or jqLite wrapper for the browser's window.document object. Dependencies $window

documented? documented?() Instance Public methods Does this class or module have a comment with content or is received_nodoc true?