2015-12-16 00:07:31 -05:00
|
|
|
# frozen_string_literal: false
|
2008-04-26 12:14:19 -04:00
|
|
|
$DEBUG_RDOC = nil
|
|
|
|
|
2012-11-26 23:28:14 -05:00
|
|
|
# :main: README.rdoc
|
2010-04-01 03:45:16 -04:00
|
|
|
|
2008-01-08 04:07:31 -05:00
|
|
|
##
|
2012-11-26 23:28:14 -05:00
|
|
|
# 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.
|
2011-05-13 20:39:16 -04:00
|
|
|
#
|
2012-11-26 23:28:14 -05:00
|
|
|
# For a simple introduction to writing or generating documentation using RDoc
|
|
|
|
# see the README.
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2008-04-26 12:14:19 -04:00
|
|
|
# == Roadmap
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2013-09-18 19:33:36 -04:00
|
|
|
# If you think you found a bug in RDoc see CONTRIBUTING@Bugs
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2012-11-26 23:28:14 -05:00
|
|
|
# If you want to use RDoc to create documentation for your Ruby source files,
|
|
|
|
# see RDoc::Markup and refer to <tt>rdoc --help</tt> for command line usage.
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2012-11-26 23:28:14 -05:00
|
|
|
# If you want to set the default markup format see
|
|
|
|
# RDoc::Markup@Supported+Formats
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2012-11-26 23:28:14 -05:00
|
|
|
# If you want to store rdoc configuration in your gem (such as the default
|
|
|
|
# markup format) see RDoc::Options@Saved+Options
|
2010-04-01 03:45:16 -04:00
|
|
|
#
|
2012-11-26 23:28:14 -05:00
|
|
|
# If you want to write documentation for Ruby files see RDoc::Parser::Ruby
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2012-11-26 23:28:14 -05:00
|
|
|
# If you want to write documentation for extensions written in C see
|
|
|
|
# RDoc::Parser::C
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2012-11-26 23:28:14 -05:00
|
|
|
# If you want to generate documentation using <tt>rake</tt> see RDoc::Task.
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2012-11-26 23:28:14 -05:00
|
|
|
# If you want to drive RDoc programmatically, see RDoc::RDoc.
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2012-11-26 23:28:14 -05:00
|
|
|
# If you want to use the library to format text blocks into HTML or other
|
|
|
|
# formats, look at RDoc::Markup.
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2012-11-26 23:28:14 -05:00
|
|
|
# If you want to make an RDoc plugin such as a generator or directive handler
|
|
|
|
# see RDoc::RDoc.
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2012-11-26 23:28:14 -05:00
|
|
|
# If you want to write your own output generator see RDoc::Generator.
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2013-09-18 19:33:36 -04:00
|
|
|
# If you want an overview of how RDoc works see CONTRIBUTING
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2012-11-26 23:28:14 -05:00
|
|
|
# == Credits
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2010-12-19 22:22:49 -05:00
|
|
|
# RDoc is currently being maintained by Eric Hodel <drbrain@segment7.net>.
|
2008-04-26 12:14:19 -04:00
|
|
|
#
|
|
|
|
# Dave Thomas <dave@pragmaticprogrammer.com> is the original author of RDoc.
|
2008-07-17 20:46:16 -04:00
|
|
|
#
|
2008-04-26 12:14:19 -04:00
|
|
|
# * 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.
|
2008-01-08 04:07:31 -05:00
|
|
|
|
|
|
|
module RDoc
|
|
|
|
|
2008-01-13 22:34:05 -05:00
|
|
|
##
|
|
|
|
# Exception thrown by any rdoc error.
|
|
|
|
|
|
|
|
class Error < RuntimeError; end
|
|
|
|
|
2008-01-08 04:07:31 -05:00
|
|
|
##
|
|
|
|
# RDoc version you are using
|
|
|
|
|
2016-09-07 18:23:38 -04:00
|
|
|
VERSION = '5.0.0.beta2'
|
2010-12-19 22:22:49 -05:00
|
|
|
|
|
|
|
##
|
|
|
|
# Method visibilities
|
|
|
|
|
|
|
|
VISIBILITIES = [:public, :protected, :private]
|
2008-01-08 04:07:31 -05:00
|
|
|
|
|
|
|
##
|
|
|
|
# Name of the dotfile that contains the description of files to be processed
|
|
|
|
# in the current directory
|
|
|
|
|
|
|
|
DOT_DOC_FILENAME = ".document"
|
|
|
|
|
2010-04-01 03:45:16 -04:00
|
|
|
##
|
|
|
|
# General RDoc modifiers
|
|
|
|
|
2008-01-13 22:34:05 -05:00
|
|
|
GENERAL_MODIFIERS = %w[nodoc].freeze
|
|
|
|
|
2010-04-01 03:45:16 -04:00
|
|
|
##
|
|
|
|
# RDoc modifiers for classes
|
|
|
|
|
2008-01-13 22:34:05 -05:00
|
|
|
CLASS_MODIFIERS = GENERAL_MODIFIERS
|
|
|
|
|
2010-04-01 03:45:16 -04:00
|
|
|
##
|
|
|
|
# RDoc modifiers for attributes
|
|
|
|
|
|
|
|
ATTR_MODIFIERS = GENERAL_MODIFIERS
|
|
|
|
|
|
|
|
##
|
|
|
|
# RDoc modifiers for constants
|
2008-01-13 22:34:05 -05:00
|
|
|
|
|
|
|
CONSTANT_MODIFIERS = GENERAL_MODIFIERS
|
|
|
|
|
2010-04-01 03:45:16 -04:00
|
|
|
##
|
|
|
|
# RDoc modifiers for methods
|
|
|
|
|
2008-01-13 22:34:05 -05:00
|
|
|
METHOD_MODIFIERS = GENERAL_MODIFIERS +
|
|
|
|
%w[arg args yield yields notnew not-new not_new doc]
|
|
|
|
|
2012-11-26 23:28:14 -05:00
|
|
|
##
|
|
|
|
# Loads the best available YAML library.
|
|
|
|
|
|
|
|
def self.load_yaml
|
|
|
|
begin
|
|
|
|
gem 'psych'
|
2015-12-22 07:08:13 -05:00
|
|
|
rescue NameError => e # --disable-gems
|
|
|
|
raise unless e.name == :gem
|
2012-11-26 23:28:14 -05:00
|
|
|
rescue Gem::LoadError
|
|
|
|
end
|
|
|
|
|
|
|
|
begin
|
|
|
|
require 'psych'
|
|
|
|
rescue ::LoadError
|
|
|
|
ensure
|
|
|
|
require 'yaml'
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
autoload :RDoc, 'rdoc/rdoc'
|
|
|
|
|
|
|
|
autoload :TestCase, 'rdoc/test_case'
|
|
|
|
|
|
|
|
autoload :CrossReference, 'rdoc/cross_reference'
|
|
|
|
autoload :ERBIO, 'rdoc/erbio'
|
|
|
|
autoload :ERBPartial, 'rdoc/erb_partial'
|
|
|
|
autoload :Encoding, 'rdoc/encoding'
|
|
|
|
autoload :Generator, 'rdoc/generator'
|
|
|
|
autoload :Options, 'rdoc/options'
|
|
|
|
autoload :Parser, 'rdoc/parser'
|
|
|
|
autoload :Servlet, 'rdoc/servlet'
|
|
|
|
autoload :RI, 'rdoc/ri'
|
|
|
|
autoload :Stats, 'rdoc/stats'
|
|
|
|
autoload :Store, 'rdoc/store'
|
|
|
|
autoload :Task, 'rdoc/task'
|
|
|
|
autoload :Text, 'rdoc/text'
|
|
|
|
|
|
|
|
autoload :Markdown, 'rdoc/markdown'
|
|
|
|
autoload :Markup, 'rdoc/markup'
|
|
|
|
autoload :RD, 'rdoc/rd'
|
|
|
|
autoload :TomDoc, 'rdoc/tom_doc'
|
|
|
|
|
|
|
|
autoload :KNOWN_CLASSES, 'rdoc/known_classes'
|
|
|
|
|
|
|
|
autoload :RubyLex, 'rdoc/ruby_lex'
|
|
|
|
autoload :RubyToken, 'rdoc/ruby_token'
|
|
|
|
autoload :TokenStream, 'rdoc/token_stream'
|
|
|
|
|
|
|
|
autoload :Comment, 'rdoc/comment'
|
|
|
|
|
2014-09-04 21:41:25 -04:00
|
|
|
autoload :I18n, 'rdoc/i18n'
|
|
|
|
|
2012-11-26 23:28:14 -05:00
|
|
|
# code objects
|
|
|
|
#
|
|
|
|
# We represent the various high-level code constructs that appear in Ruby
|
|
|
|
# programs: classes, modules, methods, and so on.
|
|
|
|
autoload :CodeObject, 'rdoc/code_object'
|
|
|
|
|
|
|
|
autoload :Context, 'rdoc/context'
|
|
|
|
autoload :TopLevel, 'rdoc/top_level'
|
|
|
|
|
|
|
|
autoload :AnonClass, 'rdoc/anon_class'
|
|
|
|
autoload :ClassModule, 'rdoc/class_module'
|
|
|
|
autoload :NormalClass, 'rdoc/normal_class'
|
|
|
|
autoload :NormalModule, 'rdoc/normal_module'
|
|
|
|
autoload :SingleClass, 'rdoc/single_class'
|
|
|
|
|
|
|
|
autoload :Alias, 'rdoc/alias'
|
|
|
|
autoload :AnyMethod, 'rdoc/any_method'
|
|
|
|
autoload :MethodAttr, 'rdoc/method_attr'
|
|
|
|
autoload :GhostMethod, 'rdoc/ghost_method'
|
|
|
|
autoload :MetaMethod, 'rdoc/meta_method'
|
|
|
|
autoload :Attr, 'rdoc/attr'
|
|
|
|
|
|
|
|
autoload :Constant, 'rdoc/constant'
|
2013-09-18 19:33:36 -04:00
|
|
|
autoload :Mixin, 'rdoc/mixin'
|
2012-11-26 23:28:14 -05:00
|
|
|
autoload :Include, 'rdoc/include'
|
|
|
|
autoload :Extend, 'rdoc/extend'
|
|
|
|
autoload :Require, 'rdoc/require'
|
|
|
|
|
2008-01-08 04:07:31 -05:00
|
|
|
end
|