Class RDoc::Markup::ToHtmlCrossref
In: lib/rdoc/markup/to_html_crossref.rb
Parent: RDoc::Markup::ToHtml

Subclass of the RDoc::Markup::ToHtml class that supports looking up words in the AllReferences list. Those that are found (like AllReferences in this comment) will be hyperlinked

Methods

handle_special_CROSSREF   new  

Attributes

context  [RW] 

Public Class methods

new(from_path, context, show_hash)

We need to record the html path of our caller so we can generate correct relative paths for any hyperlinks that we find

Public Instance methods

handle_special_CROSSREF(special)

We‘re invoked when any text matches the CROSSREF pattern (defined in MarkUp). If we fine the corresponding reference, generate a hyperlink. If the name we‘re looking for contains no punctuation, we look for it up the module/class chain. For example, HyperlinkHtml is found, even without the Generator:: prefix, because we look for it in module Generator first.

[Validate]

ruby-doc.org is a community service provided by Happy Camper Studios, a Phoenix, Arizona, Ruby application development company.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.