Method: RDoc::CodeObject#ignore

Defined in:
lib/rdoc/code_object.rb

#ignore ⇒ Object

Use this to ignore a CodeObject and all its children until found again (#record_location is called). An ignored item will not be displayed in documentation.

See github issue #55

The ignored status is temporary in order to allow implementation details to be hidden. At the end of processing a file RDoc allows all classes and modules to add new documentation to previously created classes.

If a class was ignored (via stopdoc) then reopened later with additional documentation it should be displayed. If a class was ignored and never reopened it should not be displayed. The ignore flag allows this to occur.



281
282
283
284
285
286
287
 
# File 'lib/rdoc/code_object.rb', line 281

def ignore
  return unless @track_visibility

  @ignored = true

  stop_doc
end