Class: RDoc::Generator::AllReferences
- Inherits:
-
Object
- Object
- RDoc::Generator::AllReferences
- Defined in:
- lib/rdoc/generator.rb
Overview
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.
Constant Summary collapse
- @@refs =
{}
Class Method Summary collapse
Class Method Details
.[](name) ⇒ Object
63 64 65 |
# File 'lib/rdoc/generator.rb', line 63 def AllReferences.[](name) @@refs[name] end |
.add(name, html_class) ⇒ Object
59 60 61 |
# File 'lib/rdoc/generator.rb', line 59 def AllReferences.add(name, html_class) @@refs[name] = html_class end |
.keys ⇒ Object
67 68 69 |
# File 'lib/rdoc/generator.rb', line 67 def AllReferences.keys @@refs.keys end |
.reset ⇒ Object
55 56 57 |
# File 'lib/rdoc/generator.rb', line 55 def AllReferences::reset @@refs = {} end |