RSpec
Ruby on Rails
Ruby
method
ignore
v1_9_3_125 -
Show latest stable
-
0 notes -
Class: RDoc::CodeObject
- 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 (38)
- 2_2_9 (0)
- 2_4_6 (0)
- 2_5_5 (0)
- 2_6_3 (0)
- What's this?
-
attr_overridable
(<= v1_9_1_378)
-
new
-
comment=
-
display?
-
document_children=
-
documented?
-
document_self=
-
done_documenting=
-
each_parent
-
file_name
-
force_documentation=
-
full_name=
-
ignore
-
ignored?
-
initialize_visibility
(>= v2_1_10)
-
options
(>= v2_1_10)
-
parent
(>= v2_1_10)
-
parent_file_name
-
parent_name
-
record_location
-
remove_classes_and_modules
(<= v1_9_2_180)
-
remove_methods_etc
(<= v1_9_2_180)
-
section
(>= v2_1_10)
-
start_doc
-
stop_doc
-
store=
(>= v2_1_10)
-
suppress
(>= v2_1_10)
-
suppressed?
(>= v2_1_10)
= private
= protected
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.
