$DEBUG_RDOC = nil

[0] Fix | Delete

[1] Fix | Delete

# :main: README.rdoc

[2] Fix | Delete

[3] Fix | Delete

##

[4] Fix | Delete

# RDoc produces documentation for Ruby source files by parsing the source and

[5] Fix | Delete

# extracting the definition for classes, modules, methods, includes and

[6] Fix | Delete

# requires. It associates these with optional documentation contained in an

[7] Fix | Delete

# immediately preceding comment block then renders the result using an output

[8] Fix | Delete

# formatter.

[9] Fix | Delete

#

[10] Fix | Delete

# For a simple introduction to writing or generating documentation using RDoc

[11] Fix | Delete

# see the README.

[12] Fix | Delete

#

[13] Fix | Delete

# == Roadmap

[14] Fix | Delete

#

[15] Fix | Delete

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

[16] Fix | Delete

#

[17] Fix | Delete

# If you want to use RDoc to create documentation for your Ruby source files,

[18] Fix | Delete

# see RDoc::Markup and refer to <tt>rdoc --help</tt> for command line usage.

[19] Fix | Delete

#

[20] Fix | Delete

# If you want to set the default markup format see

[21] Fix | Delete

# RDoc::Markup@Supported+Formats

[22] Fix | Delete

#

[23] Fix | Delete

# If you want to store rdoc configuration in your gem (such as the default

[24] Fix | Delete

# markup format) see RDoc::Options@Saved+Options

[25] Fix | Delete

#

[26] Fix | Delete

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

[27] Fix | Delete

#

[28] Fix | Delete

# If you want to write documentation for extensions written in C see

[29] Fix | Delete

# RDoc::Parser::C

[30] Fix | Delete

#

[31] Fix | Delete

# If you want to generate documentation using <tt>rake</tt> see RDoc::Task.

[32] Fix | Delete

#

[33] Fix | Delete

# If you want to drive RDoc programmatically, see RDoc::RDoc.

[34] Fix | Delete

#

[35] Fix | Delete

# If you want to use the library to format text blocks into HTML or other

[36] Fix | Delete

# formats, look at RDoc::Markup.

[37] Fix | Delete

#

[38] Fix | Delete

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

[39] Fix | Delete

# see RDoc::RDoc.

[40] Fix | Delete

#

[41] Fix | Delete

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

[42] Fix | Delete

#

[43] Fix | Delete

# If you want an overview of how RDoc works see CONTRIBUTING

[44] Fix | Delete

#

[45] Fix | Delete

# == Credits

[46] Fix | Delete

#

[47] Fix | Delete

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

[48] Fix | Delete

#

[49] Fix | Delete

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

[50] Fix | Delete

#

[51] Fix | Delete

# * The Ruby parser in rdoc/parse.rb is based heavily on the outstanding

[52] Fix | Delete

# work of Keiju ISHITSUKA of Nippon Rational Inc, who produced the Ruby

[53] Fix | Delete

# parser for irb and the rtags package.

[54] Fix | Delete

[55] Fix | Delete

module RDoc

[56] Fix | Delete

[57] Fix | Delete

##

[58] Fix | Delete

# Exception thrown by any rdoc error.

[59] Fix | Delete

[60] Fix | Delete

class Error < RuntimeError; end

[61] Fix | Delete

[62] Fix | Delete

##

[63] Fix | Delete

# RDoc version you are using

[64] Fix | Delete

[65] Fix | Delete

VERSION = '4.2.0'

[66] Fix | Delete

[67] Fix | Delete

##

[68] Fix | Delete

# Method visibilities

[69] Fix | Delete

[70] Fix | Delete

VISIBILITIES = [:public, :protected, :private]

[71] Fix | Delete

[72] Fix | Delete

##

[73] Fix | Delete

# Name of the dotfile that contains the description of files to be processed

[74] Fix | Delete

# in the current directory

[75] Fix | Delete

[76] Fix | Delete

DOT_DOC_FILENAME = ".document"

[77] Fix | Delete

[78] Fix | Delete

##

[79] Fix | Delete

# General RDoc modifiers

[80] Fix | Delete

[81] Fix | Delete

GENERAL_MODIFIERS = %w[nodoc].freeze

[82] Fix | Delete

[83] Fix | Delete

##

[84] Fix | Delete

# RDoc modifiers for classes

[85] Fix | Delete

[86] Fix | Delete

CLASS_MODIFIERS = GENERAL_MODIFIERS

[87] Fix | Delete

[88] Fix | Delete

##

[89] Fix | Delete

# RDoc modifiers for attributes

[90] Fix | Delete

[91] Fix | Delete

ATTR_MODIFIERS = GENERAL_MODIFIERS

[92] Fix | Delete

[93] Fix | Delete

##

[94] Fix | Delete

# RDoc modifiers for constants

[95] Fix | Delete

[96] Fix | Delete

CONSTANT_MODIFIERS = GENERAL_MODIFIERS

[97] Fix | Delete

[98] Fix | Delete

##

[99] Fix | Delete

# RDoc modifiers for methods

[100] Fix | Delete

[101] Fix | Delete

METHOD_MODIFIERS = GENERAL_MODIFIERS +

[102] Fix | Delete

%w[arg args yield yields notnew not-new not_new doc]

[103] Fix | Delete

[104] Fix | Delete

##

[105] Fix | Delete

# Loads the best available YAML library.

[106] Fix | Delete

[107] Fix | Delete

def self.load_yaml

[108] Fix | Delete

begin

[109] Fix | Delete

gem 'psych'

[110] Fix | Delete

rescue Gem::LoadError

[111] Fix | Delete

end

[112] Fix | Delete

[113] Fix | Delete

begin

[114] Fix | Delete

require 'psych'

[115] Fix | Delete

rescue ::LoadError

[116] Fix | Delete

ensure

[117] Fix | Delete

require 'yaml'

[118] Fix | Delete

end

[119] Fix | Delete

end

[120] Fix | Delete

[121] Fix | Delete

autoload :RDoc, 'rdoc/rdoc'

[122] Fix | Delete

[123] Fix | Delete

autoload :TestCase, 'rdoc/test_case'

[124] Fix | Delete

[125] Fix | Delete

autoload :CrossReference, 'rdoc/cross_reference'

[126] Fix | Delete

autoload :ERBIO, 'rdoc/erbio'

[127] Fix | Delete

autoload :ERBPartial, 'rdoc/erb_partial'

[128] Fix | Delete

autoload :Encoding, 'rdoc/encoding'

[129] Fix | Delete

autoload :Generator, 'rdoc/generator'

[130] Fix | Delete

autoload :Options, 'rdoc/options'

[131] Fix | Delete

autoload :Parser, 'rdoc/parser'

[132] Fix | Delete

autoload :Servlet, 'rdoc/servlet'

[133] Fix | Delete

autoload :RI, 'rdoc/ri'

[134] Fix | Delete

autoload :Stats, 'rdoc/stats'

[135] Fix | Delete

autoload :Store, 'rdoc/store'

[136] Fix | Delete

autoload :Task, 'rdoc/task'

[137] Fix | Delete

autoload :Text, 'rdoc/text'

[138] Fix | Delete

[139] Fix | Delete

autoload :Markdown, 'rdoc/markdown'

[140] Fix | Delete

autoload :Markup, 'rdoc/markup'

[141] Fix | Delete

autoload :RD, 'rdoc/rd'

[142] Fix | Delete

autoload :TomDoc, 'rdoc/tom_doc'

[143] Fix | Delete

[144] Fix | Delete

autoload :KNOWN_CLASSES, 'rdoc/known_classes'

[145] Fix | Delete

[146] Fix | Delete

autoload :RubyLex, 'rdoc/ruby_lex'

[147] Fix | Delete

autoload :RubyToken, 'rdoc/ruby_token'

[148] Fix | Delete

autoload :TokenStream, 'rdoc/token_stream'

[149] Fix | Delete

[150] Fix | Delete

autoload :Comment, 'rdoc/comment'

[151] Fix | Delete

[152] Fix | Delete

autoload :I18n, 'rdoc/i18n'

[153] Fix | Delete

[154] Fix | Delete

# code objects

[155] Fix | Delete

#

[156] Fix | Delete

# We represent the various high-level code constructs that appear in Ruby

[157] Fix | Delete

# programs: classes, modules, methods, and so on.

[158] Fix | Delete

autoload :CodeObject, 'rdoc/code_object'

[159] Fix | Delete

[160] Fix | Delete

autoload :Context, 'rdoc/context'

[161] Fix | Delete

autoload :TopLevel, 'rdoc/top_level'

[162] Fix | Delete

[163] Fix | Delete

autoload :AnonClass, 'rdoc/anon_class'

[164] Fix | Delete

autoload :ClassModule, 'rdoc/class_module'

[165] Fix | Delete

autoload :NormalClass, 'rdoc/normal_class'

[166] Fix | Delete

autoload :NormalModule, 'rdoc/normal_module'

[167] Fix | Delete

autoload :SingleClass, 'rdoc/single_class'

[168] Fix | Delete

[169] Fix | Delete

autoload :Alias, 'rdoc/alias'

[170] Fix | Delete

autoload :AnyMethod, 'rdoc/any_method'

[171] Fix | Delete

autoload :MethodAttr, 'rdoc/method_attr'

[172] Fix | Delete

autoload :GhostMethod, 'rdoc/ghost_method'

[173] Fix | Delete

autoload :MetaMethod, 'rdoc/meta_method'

[174] Fix | Delete

autoload :Attr, 'rdoc/attr'

[175] Fix | Delete

[176] Fix | Delete

autoload :Constant, 'rdoc/constant'

[177] Fix | Delete

autoload :Mixin, 'rdoc/mixin'

[178] Fix | Delete

autoload :Include, 'rdoc/include'

[179] Fix | Delete

autoload :Extend, 'rdoc/extend'

[180] Fix | Delete

autoload :Require, 'rdoc/require'

[181] Fix | Delete

[182] Fix | Delete

end

[183] Fix | Delete

[184] Fix | Delete

[185] Fix | Delete