Class: Generators::HTMLGenerator

Class | Generators::HTMLGenerator
In: | rdoc/generators/html_generator.rb
Parent: | Object

### Methods

for gen_url generate new

### Included Modules

MarkUp

### Public Class methods

for(options)

Generators may need to return specific subclasses depending on the options they are passed. Because of this we create them using a factory

[Source]

    # File rdoc/generators/html_generator.rb, line 1153
        def HTMLGenerator.for(options)
          AllReferences::reset
          HtmlMethod::reset

          if options.all_one_file
            HTMLGeneratorInOne.new(options)
          else
            HTMLGenerator.new(options)
          end
        end

gen_url(path, target)

convert a target url to one that is relative to a given path

[Source]

    # File rdoc/generators/html_generator.rb, line 1131
        def HTMLGenerator.gen_url(path, target)
          from          = File.dirname(path)
          to, to_file   = File.split(target)

          from = from.split("/")
          to   = to.split("/")

          while from.size > 0 and to.size > 0 and from[0] == to[0]
            from.shift
            to.shift
          end

          from.fill("..")
          from.concat(to)
          from << to_file
          File.join(*from)
        end

new(options)

Set up a new HTML generator. Basically all we do here is load up the correct output temlate

[Source]

    # File rdoc/generators/html_generator.rb, line 1171
        def initialize(options) #:not-new:
          @options    = options
          load_html_template
        end

### Public Instance methods

generate(toplevels)

Build the initial indices and output objects based on an array of TopLevel objects containing the extracted information.

[Source]

    # File rdoc/generators/html_generator.rb, line 1182
        def generate(toplevels)
          @toplevels  = toplevels
          @files      = []
          @classes    = []

          write_style_sheet
          gen_sub_directories()
          build_indices
          generate_html
        end

[Validate]