generate_servlet_not_found

generate_servlet_not_found(path) Instance Public methods Generates the 404 page for the RDoc servlet

generate_servlet_root

generate_servlet_root(installed) Instance Public methods Generates the servlet root page for the RDoc servlet

generate_table_of_contents

generate_table_of_contents() Instance Public methods Generate an index page which lists all the classes which are documented.

get_sorted_module_list

get_sorted_module_list(classes) Instance Public methods Return a list of the documented modules sorted by salience first, then by name.

get_svninfo

get_svninfo(klass) Instance Public methods Try to extract Subversion information out of the first constant whose value looks like a subversion Id tag. If no matching constant is found, and empty hash is returned.

render

render(file_name) Instance Public methods Renders the ERb contained in file_name relative to the template directory and returns the result based on the current context.

render_template

render_template(template_file, out_file = nil) Instance Public methods Load and render the erb template in the given template_file and write it out to out_file. Both template_file and out_file should be Pathname-like objects. An io will be yielded which must be captured by binding in the caller.

setup

setup() Instance Public methods Prepares for generation of output from the current directory

template_for

template_for(file, page = true, klass = ERB) Instance Public methods Retrieves a cache template for file, if present, or fills the cache.

template_result

template_result(template, context, template_file) Instance Public methods Creates the result for template with context. If an error is raised a Pathname template_file will indicate the file where the error occurred.