Class RDoc::Context
In: lib/rdoc/code_objects.rb
Parent: CodeObject

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

Methods

<=>   add_alias   add_attribute   add_class   add_class_or_module   add_constant   add_include   add_method   add_module   add_require   add_to   classes   defined_in?   each_attribute   each_classmodule   each_constant   each_method   find_enclosing_module_named   find_local_symbol   find_module_named   find_symbol   initialize_classes_and_modules   initialize_methods_etc   modules   new   ongoing_visibility=   record_location   remove_classes_and_modules   remove_methods_etc   set_current_section   set_visibility_for   toplevel  

Classes and Modules

Class RDoc::Context::Section

Attributes

aliases  [R] 
attributes  [R] 
constants  [R] 
in_files  [R] 
includes  [R] 
method_list  [R] 
name  [R] 
requires  [R] 
sections  [R] 
visibility  [R] 

Public Class methods

Public Instance methods

<=>(other)

allow us to sort modules by name

add_require(a_require)

Requires always get added to the top-level (file) context

classes()

map the class hash to an array externally

defined_in?(file)

Return true if at least part of this thing was defined in file

each_classmodule() {|m| ...}

Iterate over all the classes and modules in this object

find_enclosing_module_named(name)

find a module at a higher scope

find_symbol(symbol, method=nil)

Look up the given symbol. If method is non-nil, then we assume the symbol references a module that contains that method

modules()

map the module hash to an array externally

ongoing_visibility=(vis)

Change the default visibility for new methods

record_location(toplevel)

Record the file that we happen to find it in

remove_classes_and_modules()

and remove classes and modules when we see a :nodoc: all

remove_methods_etc()

If a class‘s documentation is turned off after we‘ve started collecting methods etc., we need to remove the ones we have

set_visibility_for(methods, vis, singleton=false)

Given an array methods of method names, set the visibility of the corresponding AnyMethod object

toplevel()

Return the toplevel that owns us

[Validate]

ruby-doc.org is a service of James Britt and Neurogami, a Ruby application development company in Phoenix, AZ.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.