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.

assemble_template

assemble_template(body_file) Instance Public methods Creates a template from

2015-05-01 23:11:01
get_svninfo

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

2015-05-02 00:16:33
setup

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

2015-05-02 00:25:45
generate_class

generate_class(klass, template_file = nil) Instance Public methods Generates

2015-05-01 23:42:07
generate

generate() Instance Public methods Build the initial indices and output objects

2015-05-01 23:37:08
time_delta_string

time_delta_string(seconds) Instance Public methods Return a string describing

2015-05-02 00:38:36
class_dir

class_dir() Instance Public methods Directory where generated class HTML files

2015-05-01 23:12:55
debug_msg

debug_msg(*msg) Instance Public methods Output progress information if debugging

2015-05-01 23:23:25
file_dir

file_dir() Instance Public methods Directory where generated class HTML files

2015-05-01 23:30:53
gen_sub_directories

gen_sub_directories() Instance Public methods Create the directories the generated

2015-05-01 23:34:50