/ Ruby
/
module

RDoc

v1_8_7_330 - Show latest stable

Extract code elements from a source file, returning a TopLevel object containing the constituent file elements.

This file is based on rtags

Constants

ATTR_MODIFIERS = GENERAL_MODIFIERS

CLASS_MODIFIERS = GENERAL_MODIFIERS

CONSTANT_MODIFIERS = GENERAL_MODIFIERS

DOT_DOC_FILENAME = ".document"

GENERAL_MODIFIERS = [ 'nodoc' ].freeze

KNOWN_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"

METHOD_MODIFIERS = GENERAL_MODIFIERS + [ 'arg', 'args', 'yield', 'yields', 'notnew', 'not-new', 'not_new', 'doc' ]

Files

  • lib/rdoc/code_objects.rb
  • lib/rdoc/diagram.rb
  • lib/rdoc/generators/template/chm/chm.rb
  • lib/rdoc/generators/template/html/hefss.rb
  • lib/rdoc/generators/template/html/html.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
  • lib/rdoc/generators/template/xml/rdf.rb
  • lib/rdoc/generators/template/xml/xml.rb
  • lib/rdoc/parsers/parse_c.rb
  • lib/rdoc/parsers/parse_f95.rb
  • lib/rdoc/parsers/parse_rb.rb
  • lib/rdoc/parsers/parse_simple.rb
  • lib/rdoc/parsers/parserfactory.rb
  • lib/rdoc/rdoc.rb
  • lib/rdoc/usage.rb

Nested classes and modules