Class Generators::AllReferences
In: generators/html_generator.rb
Parent: Object

Build a hash of all items that can be cross-referenced. This is used when we output required and included names: if the names appear in this hash, we can generate an html cross reference to the appropriate description. We also use this when parsing comment blocks: any decorated words matching an entry in this list are hyperlinked.

Methods

[]   add   keys   reset  

Public Class methods

[Source]

    # File generators/html_generator.rb, line 73
73:     def AllReferences.[](name)
74:       @@refs[name]
75:     end

[Source]

    # File generators/html_generator.rb, line 69
69:     def AllReferences.add(name, html_class)
70:       @@refs[name] = html_class
71:     end

[Source]

    # File generators/html_generator.rb, line 77
77:     def AllReferences.keys
78:       @@refs.keys
79:     end

[Source]

    # File generators/html_generator.rb, line 65
65:     def AllReferences::reset
66:       @@refs = {}
67:     end

[Validate]