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 (from_path, context, pipe: false, output_decoration: true, hyperlink_all: false, show_hash: false, autolink_excluded_words: [], warn_missing_rdoc_ref: true)

Source

# File lib/rdoc/markup/to_html_crossref.rb, line 32
def initialize(from_path, context, pipe: false, output_decoration: true,
               hyperlink_all: false, show_hash: false,
               autolink_excluded_words: [], warn_missing_rdoc_ref: true)
  raise ArgumentError, 'from_path cannot be nil' if from_path.nil?

  super(pipe: pipe, output_decoration: output_decoration)

  @context       = context
  @from_path     = from_path
  @hyperlink_all = hyperlink_all
  @show_hash     = show_hash
  @autolink_excluded_words = autolink_excluded_words
  @warn_missing_rdoc_ref = warn_missing_rdoc_ref

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

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