add_class

add_class(class_type, given_name, superclass = '::Object') Instance Public methods Adds a class named given_name with superclass. Both given_name and superclass may contain '::', and are interpreted relative to the self context. This allows handling correctly examples like these: class RDoc::Gauntlet < Gauntlet module Mod class Object # implies < ::Object class SubObject < Object # this is _not_ ::Object Given class Container::Item RDoc assumes Container is a module

add_class_or_module

add_class_or_module(mod, self_hash, all_hash) Instance Public methods Adds the class or module mod to the modules or classes Hash self_hash, and to all_hash (either TopLevel::modules_hash or TopLevel::classes_hash), unless done_documenting is true. Sets the parent of mod to self, and its section to current_section. Returns mod.

add_constant

add_constant(constant) Instance Public methods Adds constant if not already there. If it is, updates the comment, value and/or is_alias_for of the known constant if they were empty/nil.

add_extend

add_extend(ext) Instance Public methods Adds extension module ext which should be an RDoc::Extend

add_include

add_include(include) Instance Public methods Adds included module include which should be an RDoc::Include

add_method

add_method(method) Instance Public methods Adds method if not already there. If it is (as method or attribute), updates the comment if it was empty.

add_module

add_module(class_type, name) Instance Public methods Adds a module named name. If RDoc already knows name is a class then that class is returned instead. See also add_class.

add_module_alias

add_module_alias(from, name, file) Instance Public methods Adds an alias from from (a class or module) to name which was defined in file.

add_require

add_require(require) Instance Public methods Adds require to this context's top level

add_section

add_section(title, comment = nil) Instance Public methods Returns a section with title, creating it if it doesn't already exist. comment will be appended to the section's comment. A section with a title of nil will return the default section. See also RDoc::Context::Section