type

type() Instance Public methods 'module' or 'class'

update_aliases

update_aliases() Instance Public methods Updates the child modules & classes by replacing the ones that are aliases through a constant. The aliased module/class is replaced in the children and in RDoc::Store#modules_hash or RDoc::Store#classes_hash by a copy that has RDoc::ClassModule#is_alias_for set to the aliased module/class, and this copy is added to #aliases of the aliased module/class. Formatters can use the non_aliases method to retrieve children that are not aliases, f

update_extends

update_extends() Instance Public methods Deletes from extends those whose module has been removed from the documentation.

update_includes

update_includes() Instance Public methods Deletes from includes those whose module has been removed from the documentation.

new

new() Class Public methods Creates a new CodeObject that will document itself and its children

comment=

comment=(comment) Instance Public methods Replaces our comment with comment, unless it is empty.

display?

display?() Instance Public methods Should this CodeObject be shown in documentation?

document_children=

document_children=(document_children) Instance Public methods Enables or disables documentation of this CodeObject's children unless it has been turned off by :enddoc:

document_self=

document_self=(document_self) Instance Public methods Enables or disables documentation of this CodeObject unless it has been turned off by :enddoc:. If the argument is nil it means the documentation is turned off by :nodoc:.

documented?

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