Class Generators::ContextUser
In: lib/generators/templates/application/merb_core/doc/rdoc/generators/merb_generator.rb
lib/generators/templates/application/merb_stack/doc/rdoc/generators/merb_generator.rb
Parent: Object

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

Included Modules

MarkUp MarkUp

Attributes

context  [R] 
context  [R] 

Public Class methods

Public Instance methods

create table of contents if we contain sections

create table of contents if we contain sections

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

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

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

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

Build a list of constants

Build a list of constants

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 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 a summary list of all the methods in this context

Build a summary list of all the methods in this context

Create a list of HtmlMethod 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.

Create a list of HtmlMethod 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 a symbol in ourselves or our parent

Find a symbol in ourselves or our parent

convenience method to build a hyperlink # Where‘s the DRY in this?? Put this in the template where it belongs

convenience method to build a hyperlink # Where‘s the DRY in this?? Put this in the template where it belongs

Build a list from an array of Htmlxxx 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

Build a list from an array of Htmlxxx 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]