Extended maintenance of Ruby versions 1.8.7 and 1.9.2 will end on July 31, 2014. Read more

In Files

  • rdoc/generators/html_generator.rb

Parent

Files

Class/Module Index [+]

Quicksearch

Generators::AllReferences

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.

Public Class Methods

[](name) click to toggle source
 
               # File rdoc/generators/html_generator.rb, line 73
def AllReferences.[](name)
  @@refs[name]
end
            
add(name, html_class) click to toggle source
 
               # File rdoc/generators/html_generator.rb, line 69
def AllReferences.add(name, html_class)
  @@refs[name] = html_class
end
            
keys() click to toggle source
 
               # File rdoc/generators/html_generator.rb, line 77
def AllReferences.keys
  @@refs.keys
end
            
reset() click to toggle source
 
               # File rdoc/generators/html_generator.rb, line 65
def AllReferences::reset
  @@refs = {}
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus