Module: RDoc::Generator::Markup

aref_to(target_path) click to toggle source

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

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

as_href(from_path) click to toggle source

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

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

cvs_url(url, full_path) click to toggle source

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 sprintf’d into url instead.

    # File lib/rdoc/generator/markup.rb, line 48
48:   def cvs_url(url, full_path)
49:     if /%s/ =~ url then
50:       sprintf url, full_path
51:     else
52:       url + full_path
53:     end
54:   end

description() click to toggle source

Handy wrapper for marking up this object’s comment

    # File lib/rdoc/generator/markup.rb, line 28
28:   def description
29:     markup @comment
30:   end

formatter() click to toggle source

Creates an RDoc::Markup::ToHtmlCrossref formatter

    # File lib/rdoc/generator/markup.rb, line 35
35:   def formatter
36:     return @formatter if defined? @formatter
37: 
38:     show_hash = RDoc::RDoc.current.options.show_hash
39:     this = RDoc::Context === self ? self : @parent
40:     @formatter = RDoc::Markup::ToHtmlCrossref.new this.path, this, show_hash
41:   end

Home Classes Methods

In Files

Methods

Files

Class Index

RDoc::Generator::Markup

Public Instance Methods