Flowdock
method

ignore

Importance_2
v1_9_3_392 - Show latest stable - 0 notes - Class: RDoc::CodeObject
ignore() public

Use this to ignore a CodeObject and all its children until found again (#record_location is called). An ignored item will not be shown 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 shown. If a class was ignored and never reopened it should not be shown. The ignore flag allows this to occur.

Show source
Register or log in to add new notes.