A Context is something that can hold modules, classes, methods, attributes, aliases, requires, and includes. Classes, modules, and files are all Contexts.


TOMDOC_TITLES_SORT = TOMDOC_TITLES.sort_by { |title| title.to_s }

TOMDOC_TITLES = [nil, 'Public', 'Internal', 'Deprecated']

TYPES = %w[class instance]


[R] constants_hash

Hash of registered constants.

[RW] params

Params to be used in the next MethodAttr parsed under this context

[R] methods_hash

Hash of registered methods. Attributes are also registered here, twice if they are RW.

[W] current_line_visibility

Current visibility of this line

[RW] visibility

Current visibility of this context

[R] external_aliases

Aliases that could not be resolved.

[RW] unmatched_alias_lists

Hash old_name => [aliases], for aliases that haven’t (yet) been resolved to a method/attribute. (Not to be confused with the aliases of the context.)

[RW] temporary_section

Use this section for the next method, attribute or constant added.

[R] requires

Files this context requires

[R] name

Name of this class excluding namespace. See also full_name

[R] method_list

Methods defined in this context

[R] extends

Modules this context is extended with

[R] includes

Modules this context includes

[R] in_files

Files this context is found in

[W] current_section

Sets the current documentation section of documentation

[R] constants

Constants defined

[RW] block_params

Block params to be used in the next MethodAttr parsed under this context

[R] attributes

All attr* methods

[R] aliases

Class/module aliases

Show files where this class is defined (1 file)
Register or log in to add new notes.