Module: RDoc

Defined in:
lib/rdoc/rdoc.rb,
lib/rdoc/usage.rb,
lib/rdoc/diagram.rb,
lib/rdoc/code_objects.rb,
lib/rdoc/parsers/parse_c.rb,
lib/rdoc/parsers/parse_rb.rb,
lib/rdoc/parsers/parse_f95.rb,
lib/rdoc/parsers/parse_simple.rb,
lib/rdoc/parsers/parserfactory.rb,
lib/rdoc/generators/template/chm/chm.rb,
lib/rdoc/generators/template/xml/rdf.rb,
lib/rdoc/generators/template/xml/xml.rb,
lib/rdoc/generators/template/html/html.rb,
lib/rdoc/generators/template/html/hefss.rb,
lib/rdoc/generators/template/html/kilmer.rb,
lib/rdoc/generators/template/html/old_html.rb,
lib/rdoc/generators/template/html/one_page_html.rb

Overview

CSS2 RDoc HTML template

This is a template for RDoc that uses XHTML 1.0 Transitional and dictates a bit more of the appearance of the output to cascading stylesheets than the default. It was designed for clean inline code display, and uses DHTMl to toggle the visbility of each method's source with each click on the '[source]' link.

Authors

Copyright (c) 2002, 2003 The FaerieMUD Consortium. Some rights reserved.

This work is licensed under the Creative Commons Attribution License. To view a copy of this license, visit creativecommons.org/licenses/by/1.0/ or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA.

Defined Under Namespace

Modules: Page, ParserFactory Classes: Alias, AnonClass, AnyMethod, Attr, C_Parser, ClassModule, CodeObject, Constant, Context, Diagram, Fortran95parser, Include, NormalClass, NormalModule, RDoc, RDocError, Require, RubyParser, SimpleParser, SingleClass, Stats, Token, TopLevel

Constant Summary collapse

DOT_DOC_FILENAME =

Name of the dotfile that contains the description of files to be processed in the current directory

".document"
KNOWN_CLASSES =

Ruby's built-in classes.

{
  "rb_cObject"           => "Object",
  "rb_cArray"            => "Array",
  "rb_cBignum"           => "Bignum",
  "rb_cClass"            => "Class",
  "rb_cDir"              => "Dir",
  "rb_cData"             => "Data",
  "rb_cFalseClass"       => "FalseClass",
  "rb_cFile"             => "File",
  "rb_cFixnum"           => "Fixnum",
  "rb_cFloat"            => "Float",
  "rb_cHash"             => "Hash",
  "rb_cInteger"          => "Integer",
  "rb_cIO"               => "IO",
  "rb_cModule"           => "Module",
  "rb_cNilClass"         => "NilClass",
  "rb_cNumeric"          => "Numeric",
  "rb_cProc"             => "Proc",
  "rb_cRange"            => "Range",
  "rb_cRegexp"           => "Regexp",
  "rb_cString"           => "String",
  "rb_cSymbol"           => "Symbol",
  "rb_cThread"           => "Thread",
  "rb_cTime"             => "Time",
  "rb_cTrueClass"        => "TrueClass",
  "rb_cStruct"           => "Struct",
  "rb_eException"        => "Exception",
  "rb_eStandardError"    => "StandardError",
  "rb_eSystemExit"       => "SystemExit",
  "rb_eInterrupt"        => "Interrupt",
  "rb_eSignal"           => "Signal",
  "rb_eFatal"            => "Fatal",
  "rb_eArgError"         => "ArgError",
  "rb_eEOFError"         => "EOFError",
  "rb_eIndexError"       => "IndexError",
  "rb_eRangeError"       => "RangeError",
  "rb_eIOError"          => "IOError",
  "rb_eRuntimeError"     => "RuntimeError",
  "rb_eSecurityError"    => "SecurityError",
  "rb_eSystemCallError"  => "SystemCallError",
  "rb_eTypeError"        => "TypeError",
  "rb_eZeroDivError"     => "ZeroDivError",
  "rb_eNotImpError"      => "NotImpError",
  "rb_eNoMemError"       => "NoMemError",
  "rb_eFloatDomainError" => "FloatDomainError",
  "rb_eScriptError"      => "ScriptError",
  "rb_eNameError"        => "NameError",
  "rb_eSyntaxError"      => "SyntaxError",
  "rb_eLoadError"        => "LoadError",

  "rb_mKernel"           => "Kernel",
  "rb_mComparable"       => "Comparable",
  "rb_mEnumerable"       => "Enumerable",
  "rb_mPrecision"        => "Precision",
  "rb_mErrno"            => "Errno",
  "rb_mFileTest"         => "FileTest",
  "rb_mGC"               => "GC",
  "rb_mMath"             => "Math",
  "rb_mProcess"          => "Process"
}
GENERAL_MODIFIERS = 
[ 'nodoc' ].freeze
CLASS_MODIFIERS = 
GENERAL_MODIFIERS
ATTR_MODIFIERS = 
GENERAL_MODIFIERS
CONSTANT_MODIFIERS = 
GENERAL_MODIFIERS
METHOD_MODIFIERS = 
GENERAL_MODIFIERS + 
[ 'arg', 'args', 'yield', 'yields', 'notnew', 'not-new', 'not_new', 'doc' ]