Skip to content

Commit

Permalink
Generate docs with the updated RDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
soutaro committed Dec 18, 2024
1 parent b8a7a61 commit e283410
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 0 deletions.
63 changes: 63 additions & 0 deletions core/constants.rbs
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions core/env.rbs
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit e283410

Please sign in to comment.