123456789_123456789_123456789_123456789_123456789_

Module: RDoc

Overview

RDoc produces documentation for Ruby source files by parsing the source and extracting the definition for classes, modules, methods, includes and requires. It associates these with optional documentation contained in an immediately preceding comment block then renders the result using an output formatter.

For a simple introduction to writing or generating documentation using RDoc see the README.

Roadmap

If you think you found a bug in RDoc see CONTRIBUTING@Bugs

If you want to use RDoc to create documentation for your Ruby source files, see Markup and refer to rdoc --help for command line usage.

If you want to set the default markup format see RDoc::Markup@Supported+Formats

If you want to store rdoc configuration in your gem (such as the default markup format) see RDoc::Options@Saved+Options

If you want to write documentation for Ruby files see ::RDoc::Parser::Ruby

If you want to write documentation for extensions written in C see ::RDoc::Parser::C

If you want to generate documentation using rake see Task.

If you want to drive RDoc programmatically, see RDoc.

If you want to use the library to format text blocks into HTML or other formats, look at Markup.

If you want to make an RDoc plugin such as a generator or directive handler see RDoc.

If you want to write your own output generator see Generator.

If you want an overview of how RDoc works see CONTRIBUTING

Credits

RDoc is currently being maintained by Eric Hodel <drbrain@segment7.net>.

Dave Thomas <dave@pragmaticprogrammer.com> is the original author of RDoc.

  • The Ruby parser in rdoc/parse.rb is based heavily on the outstanding work of Keiju ISHITSUKA of Nippon Rational Inc, who produced the Ruby parser for irb and the rtags package.

Constant Summary

  • ATTR_MODIFIERS =

    RDoc modifiers for attributes

    # File 'lib/rdoc.rb', line 91
    GENERAL_MODIFIERS
  • CLASS_MODIFIERS =

    RDoc modifiers for classes

    # File 'lib/rdoc.rb', line 86
    GENERAL_MODIFIERS
  • CONSTANT_MODIFIERS =

    RDoc modifiers for constants

    # File 'lib/rdoc.rb', line 96
    GENERAL_MODIFIERS
  • DOT_DOC_FILENAME =

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

    # File 'lib/rdoc.rb', line 76
    ".document"
  • GENERAL_MODIFIERS =

    General RDoc modifiers

    # File 'lib/rdoc.rb', line 81
    %w[nodoc].freeze
  • KNOWN_CLASSES =

    Ruby's built-in classes, modules and exceptions

    # File 'lib/rdoc/known_classes.rb', line 7
    {
      "rb_cArray"            => "Array",
      "rb_cBasicObject"      => "BasicObject",
      "rb_cBignum"           => "Bignum",
      "rb_cClass"            => "Class",
      "rb_cData"             => "Data",
      "rb_cDir"              => "Dir",
      "rb_cEncoding"         => "Encoding",
      "rb_cFalseClass"       => "FalseClass",
      "rb_cFile"             => "File",
      "rb_cFixnum"           => "Fixnum",
      "rb_cFloat"            => "Float",
      "rb_cHash"             => "Hash",
      "rb_cIO"               => "IO",
      "rb_cInteger"          => "Integer",
      "rb_cModule"           => "Module",
      "rb_cNilClass"         => "NilClass",
      "rb_cNumeric"          => "Numeric",
      "rb_cObject"           => "Object",
      "rb_cProc"             => "Proc",
      "rb_cRange"            => "Range",
      "rb_cRegexp"           => "Regexp",
      "rb_cRubyVM"           => "RubyVM",
      "rb_cSocket"           => "Socket",
      "rb_cString"           => "String",
      "rb_cStruct"           => "Struct",
      "rb_cSymbol"           => "Symbol",
      "rb_cThread"           => "Thread",
      "rb_cTime"             => "Time",
      "rb_cTrueClass"        => "TrueClass",
    
      "rb_eArgError"         => "ArgError",
      "rb_eEOFError"         => "EOFError",
      "rb_eException"        => "Exception",
      "rb_eFatal"            => "fatal",
      "rb_eFloatDomainError" => "FloatDomainError",
      "rb_eIOError"          => "IOError",
      "rb_eIndexError"       => "IndexError",
      "rb_eInterrupt"        => "Interrupt",
      "rb_eLoadError"        => "LoadError",
      "rb_eNameError"        => "NameError",
      "rb_eNoMemError"       => "NoMemError",
      "rb_eNotImpError"      => "NotImpError",
      "rb_eRangeError"       => "RangeError",
      "rb_eRuntimeError"     => "RuntimeError",
      "rb_eScriptError"      => "ScriptError",
      "rb_eSecurityError"    => "SecurityError",
      "rb_eSignal"           => "SignalException",
      "rb_eStandardError"    => "StandardError",
      "rb_eSyntaxError"      => "SyntaxError",
      "rb_eSystemCallError"  => "SystemCallError",
      "rb_eSystemExit"       => "SystemExit",
      "rb_eTypeError"        => "TypeError",
      "rb_eZeroDivError"     => "ZeroDivError",
    
      "rb_mComparable"       => "Comparable",
      "rb_mEnumerable"       => "Enumerable",
      "rb_mErrno"            => "Errno",
      "rb_mFConst"           => "File::Constants",
      "rb_mFileTest"         => "FileTest",
      "rb_mGC"               => "GC",
      "rb_mKernel"           => "Kernel",
      "rb_mMath"             => "Math",
      "rb_mProcess"          => "Process"
    }
  • METHOD_MODIFIERS =

    RDoc modifiers for methods

    # File 'lib/rdoc.rb', line 101
    GENERAL_MODIFIERS +
    %w[arg args yield yields notnew not-new not_new doc]
  • VERSION =

    RDoc version you are using

    # File 'lib/rdoc/version.rb', line 6
    '6.2.1'
  • VISIBILITIES =

    Method visibilities

    # File 'lib/rdoc.rb', line 70
    [:public, :protected, :private]

Class Method Summary

Class Method Details

.home

[ GitHub ]

  
# File 'lib/rdoc.rb', line 123

def self.home
  rdoc_dir = begin
              File.expand_path('~/.rdoc')
            rescue ArgumentError
            end

  if File.directory?(rdoc_dir)
    rdoc_dir
  else
    begin
      # XDG
      xdg_data_home = ENV["XDG_DATA_HOME"] || File.join(File.expand_path("~"), '.local', 'share')
      unless File.exist?(xdg_data_home)
        FileUtils.mkdir_p xdg_data_home
      end
      File.join xdg_data_home, "rdoc"
    rescue Errno::EACCES
    end
  end
end

.load_yaml

Loads the best available YAML library.

[ GitHub ]

  
# File 'lib/rdoc.rb', line 107

def self.load_yaml
  begin
    gem 'psych'
  rescue NameError => e # --disable-gems
    raise unless e.name == :gem
  rescue Gem::LoadError
  end

  begin
    require 'psych'
  rescue ::LoadError
  ensure
    require 'yaml'
  end
end