Class RDoc::Generator::Context
In: lib/rdoc/generator.rb
Parent: Object
CodeObject Include Context Alias Attr AnyMethod Constant Require ClassModule NormalModule SingleClass AnonClass NormalClass TopLevel RubyParser RubyToken RuntimeError Error Error AttributeFormatter AnsiFormatter OverstrikeFormatter HtmlFormatter DefaultDisplay NamedThing IncludedModule Attribute Constant MethodSummary AliasName ClassEntry TopLevelEntry Description MethodDescription ModuleDescription ClassDescription Formatter SimpleFormatter HTML HTMLInOne XML CHM Context Method Class File Element Edge Node Subgraph Digraph SimpleElement Port Options Diagram Fortran95parser RDoc SimpleParser Token Markup TemplatePage Stats C_Parser NameDescriptor Cache Reader Writer Driver MethodEntry RI AllReferences Display Paths RI MarkUp Generator TokenStream ParserFactory DOT RDoc dot/f_4.png

A Context is built by the parser to represent a container: contexts hold classes, modules, methods, require lists and include lists. ClassModule and TopLevel are the context objects we process here

Methods

add_table_of_sections   aref_to   as_href   build_alias_summary_list   build_class_list   build_class_list   build_constants_summary_list   build_include_list   build_indicies   build_method_detail_list   build_method_summary_list   build_requires_list   collect_methods   diagram_reference   document_self   find_symbol   href   new   potentially_referenced_list   url  

Included Modules

MarkUp

Public Class methods

build_indicies(toplevels, options)

Generate:

Public Instance methods

add_table_of_sections()

create table of contents if we contain sections

as_href(from_path)

Returns a reference to outselves to be used as an href= the form depends on whether we‘re all in one file or in multiple files

build_alias_summary_list(section)

Build a list of aliases for which we couldn‘t find a corresponding method

build_class_list(level, from, section, infile=nil)

Build the structured list of classes and modules contained in this context.

build_constants_summary_list(section)

Build a list of constants

build_method_detail_list(section)

Build an array of arrays of method details. The outer array has up to six entries, public, private, and protected for both class methods, the other for instance methods. The inner arrays contain a hash for each method

build_method_summary_list(path_prefix="")

Build a summary list of all the methods in this context

collect_methods()

Create a list of Method objects for each method in the corresponding context object. If the @options.show_all variable is set (corresponding to the —all option, we include all methods, otherwise just the public ones.

find_symbol(symbol, method=nil)

Find a symbol in ourselves or our parent

href(link, cls, name)

convenience method to build a hyperlink

potentially_referenced_list(array) {|i.name| ...}

Build a list from an array of Context items. Look up each in the AllReferences hash: if we find a corresponding entry, we generate a hyperlink to it, otherwise just output the name. However, some names potentially need massaging. For example, you may require a Ruby file without the .rb extension, but the file names we know about may have it. To deal with this, we pass in a block which performs the massaging, returning an array of alternative names to match

[Validate]