end_accepting() Instance Public methods Returns the generated output

start_accepting() Instance Public methods Prepares the visitor for HTML generation

new(options, from_path, context, markup = nil) Class Public methods Creates a new crossref resolver that generates links relative to context which lives at from_path in the generated files. '#' characters on references are removed unless show_hash is true. Only method names preceded by '#' or '::' are linked, unless hyperlink_all is true.

cross_reference(name, text = nil) Instance Public methods Creates a link to the reference name if the name exists. If text is given it is used as the link text, otherwise name is used.

gen_url(url, text) Instance Public methods Generates links for rdoc-ref: scheme URLs and allows RDoc::Markup::ToHtml to handle other schemes.

handle_special_CROSSREF(special) Instance Public methods We're invoked when any text matches the CROSSREF pattern. If we find the corresponding reference, generate a link. If the name we're looking for contains no punctuation, we look for it up the module/class chain. For example, ToHtml is found, even without the RDoc::Markup:: prefix, because we look for it in module Markup first.

handle_special_HYPERLINK(special) Instance Public methods Handles rdoc-ref: scheme links and allows RDoc::Markup::ToHtml to handle other schemes.

handle_special_RDOCLINK(special) Instance Public methods special is an rdoc-schemed link that will be converted into a hyperlink. For the rdoc-ref scheme the cross-reference will be looked up and the given name will be used. All other contents are handled by the superclass

link(name, text) Instance Public methods Creates an HTML link to name with the given text.

new(options, characters = 100, paragraphs = 3, markup = nil) Class Public methods Creates a new ToHtmlSnippet formatter that will cut off the input on the next word boundary after the given number of characters or paragraphs of text have been encountered.