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.

render
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

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

2025-01-10 15:47:30
generate_servlet_root
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

generate_servlet_root(installed) Instance Public methods Generates the servlet

2025-01-10 15:47:30
generate
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

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

2025-01-10 15:47:30
generate_class
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

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

2025-01-10 15:47:30
setup
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

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

2025-01-10 15:47:30
time_delta_string
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

time_delta_string(seconds) Instance Public methods Return a string describing

2025-01-10 15:47:30
debug_msg
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

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

2025-01-10 15:47:30
gen_sub_directories
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

gen_sub_directories() Instance Public methods Create the directories the generated

2025-01-10 15:47:30
copy_static
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

copy_static() Instance Public methods Copies static files from the static_path

2025-01-10 15:47:30
render_template
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

render_template(template_file, out_file = nil) Instance Public methods Load

2025-01-10 15:47:30