Module

R2Doc::ContextExtensions

Inheritance

Extensions for the RDoc::Generator::Context / Generators::ContextUser class

Constants

Name   Description
VISIBILITY_VALUE = { :public=>0, :protected=>1, :private=>2 } Numeric value associated with visibility values for sorting

Methods

Instance

Visibility Signature
public aliases ()
public all_methods ()
public attributes ()
public class_methods ()
public classes ()
public constants ()
public description (temporaryPath = nil)
public has_aliases? ()
public has_attributes? ()
public has_class_methods? ()
public has_classes? ()
public has_classes_or_modules? ()
public has_constants? ()
public has_includes? ()
public has_instance_methods? ()
public has_modules? ()
public includes ()
public instance_methods ()
public is_method_context? ()
public modules ()
public name_path_to_parent ()
public parent ()
protected method_hash (m)
protected sort_members (members)

Instance Method Detail

aliases()

Return a list of Hashes for all aliases containing the following keys:

:old_name
The old name
:new_name
The new name
:description
Alias description markup

all_methods()

Returns a collection of HtmlMethod objects for all methods in this context

attributes()

Return a list of Hashes for all documentable attributes containing the following keys:

:name
The attribute name
:visibility
:public, :protected, or :private
:rw
‘r‘ or ‘rw‘
:description
Attribute description markup

class_methods()

Return a list of Hashes for all documentable class methods containing the following keys:

:name
The method name
:visibility
:public:, :protected, or :private
:params
Method call signature markup (does not include method name)
:callseq
Markup documenting alternative ways to call the method (should take precedence over name and params when present)
:url
The relative URL to the method from the documentation root (e.g. ‘classes/Foo.html#bar‘)
:anchor
The name of the anchor for this method (e.g. ‘bar‘)
:description
Method description markup

classes()

The collection of classes contained within this context

constants()

Return a list of Hashes for all constants containing the following keys:

:name
The constant name
:value
The value of the constant
:description
Constant description markup

description(temporaryPath = nil)

Return the description markup for this context

has_aliases?()

Return true if this context contains aliases

has_attributes?()

Return true if this context contains attributes

has_class_methods?()

Returns true if the context contains class (singleton) methods

has_classes?()

Returns true if this context contains classes

has_classes_or_modules?()

Returns true if this context contains classes or modules

has_constants?()

Returns true if the context contains contants

has_includes?()

Returns true if this context has included modules

has_instance_methods?()

Returns true if the context contains instance (non-singleton) methods

has_modules?()

Returns true if this context contains modules

includes()

The collection of included modules. This returns a hash with the folliwing keys for each module:

:name
The module name
:url
The relative URL to the module from the documentation root

instance_methods()

Return a list of Hashes for all documentable instance methods. See class_methods for Hash key information.

is_method_context?()

Returns true if this object is a method context

modules()

The collection of modules contained within this context

name_path_to_parent()

Return an array representing the navigational path to this class in the namespace hierarchy. The first item in the array is the outermost class or module. The class itself is not included in the array, nor is the root of the namespace. So, for a class A::B::C::D, the returned array will contain the A module, the B module, and the C module, in that order. All items in the array are instances of ContextUser

parent()

Return the parent ContextUser of this object

method_hash(m)

Assembles a Hash for an HTMLMethod, m. This is used by class_methods and instance_methods.

sort_members(members)

Sort members by visibility, then name