?HAMA

Navigation

Breadcrumbs

/ / proc / thread-self / root / opt / alt / ruby25 / lib64 / ruby / 2.5.0

Create

Create File | Create Folder | Upload Files | Run Command

Edit File Size: 5.04 KB

//proc/thread-self/root/opt/alt/ruby25/lib64/ruby/2.5.0/rdoc.rb

Text Base64

# frozen_string_literal: true
$DEBUG_RDOC = nil

# :main: README.rdoc

##
# 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 RDoc::Markup and refer to <tt>rdoc --help</tt> 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 <tt>rake</tt> see RDoc::Task.
#
# If you want to drive RDoc programmatically, see RDoc::RDoc.
#
# If you want to use the library to format text blocks into HTML or other
# formats, look at RDoc::Markup.
#
# If you want to make an RDoc plugin such as a generator or directive handler
# see RDoc::RDoc.
#
# If you want to write your own output generator see RDoc::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.

module RDoc

##
  # Exception thrown by any rdoc error.

class Error < RuntimeError; end

##
  # RDoc version you are using

VERSION = '6.0.1.1'

##
  # Method visibilities

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

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

DOT_DOC_FILENAME = ".document"

##
  # General RDoc modifiers

GENERAL_MODIFIERS = %w[nodoc].freeze

##
  # RDoc modifiers for classes

CLASS_MODIFIERS = GENERAL_MODIFIERS

##
  # RDoc modifiers for attributes

ATTR_MODIFIERS = GENERAL_MODIFIERS

##
  # RDoc modifiers for constants

CONSTANT_MODIFIERS = GENERAL_MODIFIERS

##
  # RDoc modifiers for methods

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

##
  # Loads the best available YAML library.

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

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 :RipperStateLex, 'rdoc/parser/ripper_state_lex'
  autoload :TokenStream,    'rdoc/token_stream'

autoload :Comment,        'rdoc/comment'

autoload :I18n,           'rdoc/i18n'

# 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'
  autoload :Mixin,          'rdoc/mixin'
  autoload :Include,        'rdoc/include'
  autoload :Extend,         'rdoc/extend'
  autoload :Require,        'rdoc/require'

end

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Directory Contents

Dirs: 27 × Files: 70

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
cgi DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
digest DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
drb DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
fiddle DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
forwardable DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
io DIR	-	drwxr-xr-x	2024-03-03 22:47:48	Edit Download recursive recursive
irb DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
json DIR	-	drwxr-xr-x	2024-03-03 22:47:48	Edit Download recursive recursive
matrix DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
net DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
openssl DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
optparse DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
psych DIR	-	drwxr-xr-x	2024-03-03 22:47:50	Edit Download recursive recursive
racc DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
rdoc DIR	-	drwxr-xr-x	2024-03-03 22:47:51	Edit Download recursive recursive
rexml DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
rinda DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
ripper DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
rss DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
rubygems DIR	-	drwxr-xr-x	2024-03-03 22:47:52	Edit Download recursive recursive
shell DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
syslog DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
unicode_normalize DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
uri DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
webrick DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
x86_64-linux DIR	-	drwxr-xr-x	2024-03-03 22:47:50	Edit Download recursive recursive
yaml DIR	-	drwxr-xr-x	2024-03-03 22:47:46	Edit Download recursive recursive
abbrev.rb	3.49 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
base64.rb	3.30 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
benchmark.rb	17.89 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
cgi.rb	9.80 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
cmath.rb	9.49 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
csv.rb	82.88 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
date.rb	1003 B	lrw-r--r--	2023-07-26 14:55:49	Edit Download recursive recursive
debug.rb	29.97 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
delegate.rb	10.44 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
digest.rb	2.83 KB	lrw-r--r--	2023-07-26 14:55:49	Edit Download recursive recursive
drb.rb	50 B	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
e2mmap.rb	3.94 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
English.rb	6.31 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
erb.rb	27.46 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
expect.rb	2.17 KB	lrw-r--r--	2023-07-26 14:55:49	Edit Download recursive recursive
fiddle.rb	1.68 KB	lrw-r--r--	2023-07-26 14:55:49	Edit Download recursive recursive
fileutils.rb	44.15 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
find.rb	2.47 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
forwardable.rb	8.49 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
getoptlong.rb	15.42 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
ipaddr.rb	19.51 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
irb.rb	20.48 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
json.rb	1.77 KB	lrw-r--r--	2023-07-26 14:55:49	Edit Download recursive recursive
kconv.rb	5.77 KB	lrw-r--r--	2023-07-26 14:55:49	Edit Download recursive recursive
logger.rb	23.54 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
matrix.rb	53.20 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
mkmf.rb	84.40 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
monitor.rb	7.71 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
mutex_m.rb	2.02 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
observer.rb	5.83 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
open-uri.rb	25.11 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
open3.rb	20.94 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
openssl.rb	469 B	lrw-r--r--	2023-07-26 14:55:49	Edit Download recursive recursive
optionparser.rb	59 B	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
optparse.rb	57.25 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
ostruct.rb	10.16 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
pathname.rb	16.09 KB	lrw-r--r--	2023-07-26 14:55:49	Edit Download recursive recursive
pp.rb	14.36 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
prettyprint.rb	15.89 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
prime.rb	12.48 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
profile.rb	235 B	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
profiler.rb	4.54 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
pstore.rb	14.70 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
psych.rb	16.54 KB	lrw-r--r--	2023-07-26 14:55:49	Edit Download recursive recursive
rdoc.rb	5.04 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
resolv-replace.rb	1.76 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
resolv.rb	73.66 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
ripper.rb	2.44 KB	lrw-r--r--	2023-07-26 14:55:49	Edit Download recursive recursive
rss.rb	2.87 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
rubygems.rb	36.40 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
scanf.rb	23.57 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
securerandom.rb	8.67 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
set.rb	24.01 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
shell.rb	11.37 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
shellwords.rb	6.66 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
singleton.rb	4.04 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
socket.rb	43.51 KB	lrw-r--r--	2023-07-26 14:55:49	Edit Download recursive recursive
sync.rb	7.29 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
tempfile.rb	11.14 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
thwait.rb	3.33 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
time.rb	22.38 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
timeout.rb	3.81 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
tmpdir.rb	4.25 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
tracer.rb	6.42 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
tsort.rb	14.30 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
un.rb	9.78 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
uri.rb	3.10 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
weakref.rb	1.44 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
webrick.rb	6.72 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive
yaml.rb	1.73 KB	lrw-r--r--	2021-04-05 11:46:35	Edit Download recursive recursive