Merge pull request #2182 from ruby/update-rdoc

Update docs with rdoc-6.10.0

Author: soutaro

Gemfile.lock

@@ -85,7 +85,7 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rdoc (6.9.1)
+    rdoc (6.10.0)
       psych (>= 4.0.0)
     regexp_parser (2.9.3)
     rspec (3.13.0)

core/constants.rbs

@@ -1,33 +1,96 @@
+# <!-- rdoc-file=io.c -->
+# ARGF is a stream designed for use in scripts that process files given as
+# command-line arguments or passed in via STDIN.
+#
+# See ARGF (the class) for more details.
+#
 ARGF: RBS::Unnamed::ARGFClass
 
+# <!-- rdoc-file=ruby.c -->
+# ARGV contains the command line arguments used to run ruby.
+#
+# A library like OptionParser can be used to process command-line arguments.
+#
 ARGV: Array[String]
 
 CROSS_COMPILING: true?
 
+# <!-- rdoc-file=ruby.c -->
+# DATA is a File that contains the data section of the executed file. To create
+# a data section use `__END__`:
+#
+#     $ cat t.rb
+#     puts DATA.gets
+#     __END__
+#     hello world!
+#
+#     $ ruby t.rb
+#     hello world!
+#
 DATA: File
 
+# <!-- rdoc-file=version.c -->
+# The copyright string for ruby
+#
 RUBY_COPYRIGHT: String
 
+# <!-- rdoc-file=version.c -->
+# The full ruby version string, like `ruby -v` prints
+#
 RUBY_DESCRIPTION: String
 
+# <!-- rdoc-file=version.c -->
+# The engine or interpreter this ruby uses.
+#
 RUBY_ENGINE: String
 
+# <!-- rdoc-file=version.c -->
+# The version of the engine or interpreter this ruby uses.
+#
 RUBY_ENGINE_VERSION: String
 
+# <!-- rdoc-file=version.c -->
+# The patchlevel for this ruby.  If this is a development build of ruby the
+# patchlevel will be -1
+#
 RUBY_PATCHLEVEL: Integer
 
+# <!-- rdoc-file=version.c -->
+# The platform for this ruby
+#
 RUBY_PLATFORM: String
 
+# <!-- rdoc-file=version.c -->
+# The date this ruby was released
+#
 RUBY_RELEASE_DATE: String
 
+# <!-- rdoc-file=version.c -->
+# The GIT commit hash for this ruby.
+#
 RUBY_REVISION: String
 
+# <!-- rdoc-file=version.c -->
+# The running version of ruby
+#
 RUBY_VERSION: String
 
+# <!-- rdoc-file=io.c -->
+# Holds the original stderr
+#
 STDERR: IO
 
+# <!-- rdoc-file=io.c -->
+# Holds the original stdin
+#
 STDIN: IO
 
+# <!-- rdoc-file=io.c -->
+# Holds the original stdout
+#
 STDOUT: IO
 
+# <!-- rdoc-file=vm.c -->
+# The Binding of the top level scope
+#
 TOPLEVEL_BINDING: Binding

core/env.rbs

@@ -1 +1,6 @@
+# <!-- rdoc-file=hash.c -->
+# ENV is a Hash-like accessor for environment variables.
+#
+# See ENV (the class) for more details.
+#
 ENV: RBS::Unnamed::ENVClass