Module: RDoc::Generator::Markup

### Home Classes Methods

### In Files

- lib/rdoc/generator/markup.rb

### Methods

- #aref_to
- #as_href
- #cvs_url
- #description
- #formatter

### Files

- CONTRIBUTING.rdoc
- CVE-2013-0256.rdoc
- ExampleRDoc.rdoc
- LICENSE.rdoc
- Manifest.txt
- README.rdoc
- RI.rdoc
- Rakefile
- TODO.rdoc

### Class/Module Index

Quicksearch

- RDoc
- RDoc::Alias
- RDoc::AnonClass
- RDoc::AnyMethod
- RDoc::Attr
- RDoc::ClassModule
- RDoc::CodeObject
- RDoc::Comment
- RDoc::Constant
- RDoc::Context
- RDoc::Context::Section
- RDoc::CrossReference
- RDoc::ERBIO
- RDoc::ERBPartial
- RDoc::Encoding
- RDoc::Error
- RDoc::Extend
- RDoc::Gauntlet
- RDoc::Generator
- RDoc::Generator::Darkfish
- RDoc::Generator::JsonIndex
- RDoc::Generator::Markup
- RDoc::Generator::POT
- RDoc::Generator::RI
- RDoc::GhostMethod
- RDoc::Include
- RDoc::Markdown
- RDoc::Markdown::Literals
- RDoc::Markup
- RDoc::Markup::AttrChanger
- RDoc::Markup::AttrSpan
- RDoc::Markup::AttributeManager
- RDoc::Markup::Attributes
- RDoc::Markup::BlankLine
- RDoc::Markup::BlockQuote
- RDoc::Markup::Document
- RDoc::Markup::Formatter
- RDoc::Markup::FormatterTestCase
- RDoc::Markup::HardBreak
- RDoc::Markup::Include
- RDoc::Markup::IndentedParagraph
- RDoc::Markup::List
- RDoc::Markup::ListItem
- RDoc::Markup::Paragraph
- RDoc::Markup::Parser
- RDoc::Markup::Parser::Error
- RDoc::Markup::Parser::ParseError
- RDoc::Markup::PreProcess
- RDoc::Markup::Raw
- RDoc::Markup::Rule
- RDoc::Markup::Special
- RDoc::Markup::TextFormatterTestCase
- RDoc::Markup::ToAnsi
- RDoc::Markup::ToBs
- RDoc::Markup::ToHtml
- RDoc::Markup::ToHtmlCrossref
- RDoc::Markup::ToHtmlSnippet
- RDoc::Markup::ToJoinedParagraph
- RDoc::Markup::ToLabel
- RDoc::Markup::ToMarkdown
- RDoc::Markup::ToRdoc
- RDoc::Markup::ToTableOfContents
- RDoc::Markup::ToTest
- RDoc::Markup::ToTtOnly
- RDoc::Markup::Verbatim
- RDoc::MetaMethod
- RDoc::MethodAttr
- RDoc::Mixin
- RDoc::NormalClass
- RDoc::NormalModule
- RDoc::Options
- RDoc::Parser
- RDoc::Parser::C
- RDoc::Parser::ChangeLog
- RDoc::Parser::Markdown
- RDoc::Parser::RD
- RDoc::Parser::Ruby
- RDoc::Parser::RubyTools
- RDoc::Parser::Simple
- RDoc::Parser::Text
- RDoc::RD
- RDoc::RD::BlockParser
- RDoc::RD::Inline
- RDoc::RD::InlineParser
- RDoc::RDoc
- RDoc::RI
- RDoc::RI::Driver
- RDoc::RI::Driver::Error
- RDoc::RI::Driver::NotFoundError
- RDoc::RI::Error
- RDoc::RI::Paths
- RDoc::Require
- RDoc::RubyLex
- RDoc::RubyLex::Error
- RDoc::RubyToken
- RDoc::RubygemsHook
- RDoc::Servlet
- RDoc::SingleClass
- RDoc::Stats
- RDoc::Stats::Normal
- RDoc::Stats::Quiet
- RDoc::Stats::Verbose
- RDoc::Store
- RDoc::Store::Error
- RDoc::Store::MissingFileError
- RDoc::Task
- RDoc::Task
- RDoc::TestCase
- RDoc::TokenStream
- RDoc::TomDoc
- RDoc::TopLevel
- Object

No matching classes.

# 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) click to toggle source

Generates a relative URL from this object's path to `target_path`

    # File lib/rdoc/generator/markup.rb, line 12
    def aref_to(target_path)
      RDoc::Markup::ToHtml.gen_relative_url path, target_path
    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 19
    def as_href(from_path)
      RDoc::Markup::ToHtml.gen_relative_url from_path, path
    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 will replace the %s using sprintf on the `url`.

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

description() click to toggle source

Handy wrapper for marking up this object's comment

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

formatter() click to toggle source

Creates an RDoc::Markup::ToHtmlCrossref formatter

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

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

      @formatter = RDoc::Markup::ToHtmlCrossref.new options, this.path, this
      @formatter.code_object = self
      @formatter
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.