module RDoc::Generator::Markup

Handle common RDoc::Markup tasks for various CodeObjects

This module is loaded by generators. It allows RDoc’s CodeObject tree to avoid loading generator code to improve startup time for ri.

Public Instance Methods

aref_to (target_path)

{} Source

# File lib/rdoc/generator/markup.rb, line 13
def aref_to(target_path)
  RDoc::Markup::ToHtml.gen_relative_url path, target_path
end

Generates a relative URL from this object’s path to target_path

as_href (from_path)

{} Source

# File lib/rdoc/generator/markup.rb, line 20
def as_href(from_path)
  RDoc::Markup::ToHtml.gen_relative_url from_path, path
end

Generates a relative URL from from_path to this object’s path

canonical_url ()

{} Source

# File lib/rdoc/generator/markup.rb, line 69
def canonical_url
  options = @store.options
  if path
    File.join(options.canonical_root, path.to_s)
  else
    options.canonical_root
  end
end

The preferred URL for this object.

cvs_url (url, full_path)

{} Source

# File lib/rdoc/generator/markup.rb, line 58
def cvs_url(url, full_path)
  if /%s/ =~ url then
    sprintf url, full_path
  else
    url + full_path
  end
end

Build a webcvs URL starting for the given url with full_path appended as the destination path. If url contains ‘%s’ full_path will be will replace the %s using sprintf on the url.

description ()

{} Source

# File lib/rdoc/generator/markup.rb, line 27
def description
  markup @comment
end

Handy wrapper for marking up this object’s comment

formatter ()

{} Source

# File lib/rdoc/generator/markup.rb, line 34
def formatter
  return @formatter if defined? @formatter

  options = @store.options
  this = RDoc::Context === self ? self : @parent

  @formatter = RDoc::Markup::ToHtmlCrossref.new(
    this.path, this,
    pipe: options.pipe,
    output_decoration: options.output_decoration,
    hyperlink_all: options.hyperlink_all,
    show_hash: options.show_hash,
    autolink_excluded_words: options.autolink_excluded_words || [],
    warn_missing_rdoc_ref: options.warn_missing_rdoc_ref
  )
  @formatter.code_object = self
  @formatter
end

Creates an RDoc::Markup::ToHtmlCrossref formatter