Type:
Class
Constants:
GENERATOR_DIR : File.join 'rdoc', 'generator'

Path to this file's parent directory. Used to find templates and other resources.

VERSION : '3'

Release Version

DESCRIPTION : 'HTML generator, written by Michael Granger'

Description of this generator

SVNID_PATTERN : / \$Id:\s (\S+)\s # filename (\d+)\s # rev (\d{4}-\d{2}-\d{2})\s # Date (YYYY-MM-DD) (\d{2}:\d{2}:\d{2}Z)\s # Time (HH:MM:SSZ) (\w+)\s # committer \$$ /x

%q$Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $â

Darkfish RDoc HTML Generator

$Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $

Author/s

  • Michael Granger (ged@FaerieMUD.org)

Contributors

  • Mahlon E. Smith (mahlon@martini.nu)

  • Eric Hodel (drbrain@segment7.net)

License

Copyright © 2007, 2008, Michael Granger. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the author/s, nor the names of the project's contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Attributions

Darkfish uses the Silk Icons set by Mark James.

generate_servlet_not_found

generate_servlet_not_found(path) Instance Public methods Generates the 404 page

2015-05-01 23:58:27
template_result

template_result(template, context, template_file) Instance Public methods Creates

2015-05-02 00:35:48
template_for

template_for(file, page = true, klass = ERB) Instance Public methods Retrieves

2015-05-02 00:29:00
write_style_sheet

write_style_sheet() Instance Public methods Copy over the stylesheet into the

2015-05-02 00:44:32
get_svninfo

get_svninfo(klass) Instance Public methods Try to extract Subversion information

2015-05-02 00:16:33
render

render(file_name) Instance Public methods Renders the ERb contained in file_name

2015-05-02 00:18:09
assemble_template

assemble_template(body_file) Instance Public methods Creates a template from

2015-05-01 23:11:01
get_sorted_module_list

get_sorted_module_list(classes) Instance Public methods Return a list of the

2015-05-02 00:12:32
generate_index

generate_index() Instance Public methods Generate an index page which lists

2015-05-01 23:51:23
generate_table_of_contents

generate_table_of_contents() Instance Public methods Generate an index page

2015-05-02 00:05:29