class RDoc::Markup::ToHtmlCrossref - rdoc: Ruby Standard Library Documentation

# class RDoc::Markup::ToHtmlCrossref

Subclass of the `RDoc::Markup::ToHtml` class that supports looking up method names, classes, etc to create links. `RDoc::CrossReference` is used to generate those links based on the current context.

### Attributes

context[RW]

`RDoc::CodeObject` for generating references

show_hash[RW]

Should we show ‘#’ characters on method references?

### Public Class Methods

new(options, from_path, context, markup = nil) click to toggle source

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.

Calls superclass method `RDoc::Markup::ToHtml::new`

    # File rdoc/markup/to_html_crossref.rb, line 32
    def initialize(options, from_path, context, markup = nil)
      raise ArgumentError, 'from_path cannot be nil' if from_path.nil?

      super options, markup

      @context       = context
      @from_path     = from_path
      @hyperlink_all = @options.hyperlink_all
      @show_hash     = @options.show_hash

      @cross_reference = RDoc::CrossReference.new @context
    end