diff --git a/Gemfile.lock b/Gemfile.lock
index b53c1a1..8f84c4f 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -13,7 +13,7 @@ GEM
bigdecimal (3.1.9)
docile (1.4.1)
erubi (1.13.1)
- json (2.10.2)
+ json (2.21.2)
language_server-protocol (3.17.0.4)
lint_roller (1.1.0)
logger (1.7.0)
@@ -109,7 +109,7 @@ GEM
unicode-display_width (3.1.4)
unicode-emoji (~> 4.0, >= 4.0.4)
unicode-emoji (4.2.0)
- yard (0.9.37)
+ yard (0.9.45)
yard-sorbet (0.9.0)
sorbet-runtime
yard
diff --git a/sub_projects/rbi_generator/Gemfile.lock b/sub_projects/rbi_generator/Gemfile.lock
index fe944cf..0623e07 100644
--- a/sub_projects/rbi_generator/Gemfile.lock
+++ b/sub_projects/rbi_generator/Gemfile.lock
@@ -45,7 +45,7 @@ GEM
thor (>= 1.2.0)
yard-sorbet
thor (1.3.2)
- yard (0.9.37)
+ yard (0.9.45)
yard-sorbet (0.9.0)
sorbet-runtime
yard
diff --git a/sub_projects/sorbet_user/Gemfile.lock b/sub_projects/sorbet_user/Gemfile.lock
index cde8988..b5f8163 100644
--- a/sub_projects/sorbet_user/Gemfile.lock
+++ b/sub_projects/sorbet_user/Gemfile.lock
@@ -11,7 +11,7 @@ GEM
ast (2.4.3)
benchmark (0.4.0)
erubi (1.13.1)
- json (2.10.2)
+ json (2.21.2)
language_server-protocol (3.17.0.4)
lint_roller (1.1.0)
logger (1.7.0)
@@ -101,7 +101,7 @@ GEM
unicode-display_width (3.1.4)
unicode-emoji (~> 4.0, >= 4.0.4)
unicode-emoji (4.2.0)
- yard (0.9.37)
+ yard (0.9.45)
yard-sorbet (0.9.0)
sorbet-runtime
yard
diff --git a/sub_projects/sorbet_user/sorbet/rbi/gems/json@2.10.2.rbi b/sub_projects/sorbet_user/sorbet/rbi/gems/json@2.21.2.rbi
similarity index 83%
rename from sub_projects/sorbet_user/sorbet/rbi/gems/json@2.10.2.rbi
rename to sub_projects/sorbet_user/sorbet/rbi/gems/json@2.21.2.rbi
index 668bb3e..c47737c 100644
--- a/sub_projects/sorbet_user/sorbet/rbi/gems/json@2.10.2.rbi
+++ b/sub_projects/sorbet_user/sorbet/rbi/gems/json@2.21.2.rbi
@@ -5,47 +5,19 @@
# Please instead update this file by running `bin/tapioca gem json`.
-class Array
- include ::Enumerable
- include ::JSON::Ext::Generator::GeneratorMethods::Array
-end
-
-# Extends any Class to include _json_creatable?_ method.
-#
-# source://json//lib/json/common.rb#979
-class Class < ::Module
- # Returns true if this class can be used to create an instance
- # from a serialised JSON string. The class has to implement a class
- # method _json_create_ that expects a hash as first parameter. The hash
- # should include the required data.
- #
- # @return [Boolean]
- #
- # source://json//lib/json/common.rb#984
- def json_creatable?; end
-end
-
-class FalseClass
- include ::JSON::Ext::Generator::GeneratorMethods::FalseClass
-end
-
-class Float < ::Numeric
- include ::JSON::Ext::Generator::GeneratorMethods::Float
-end
-
-class Hash
- include ::Enumerable
- include ::JSON::Ext::Generator::GeneratorMethods::Hash
-end
-
-class Integer < ::Numeric
- include ::JSON::Ext::Generator::GeneratorMethods::Integer
-end
-
# = JavaScript \Object Notation (\JSON)
#
# \JSON is a lightweight data-interchange format.
#
+# \JSON is easy for us humans to read and write,
+# and equally simple for machines to read (parse) and write (generate).
+#
+# \JSON is language-independent, making it an ideal interchange format
+# for applications in differing programming languages
+# and on differing operating systems.
+#
+# == \JSON Values
+#
# A \JSON value is one of the following:
# - Double-quoted text: "foo".
# - Number: +1+, +1.0+, +2.0e2+.
@@ -152,9 +124,11 @@ end
# ====== Input Options
#
# Option +max_nesting+ (\Integer) specifies the maximum nesting depth allowed;
-# defaults to +100+; specify +false+ to disable depth checking.
+# defaults to +100+;
+# You can set it to +false+ to disable depth checking entirely, but that is dangerous
+# when parsing untrusted input.
#
-# With the default, +false+:
+# With the default, +100+:
# source = '[0, [1, [2, [3]]]]'
# ruby = JSON.parse(source)
# ruby # => [0, [1, [2, [3]]]]
@@ -167,6 +141,24 @@ end
#
# ---
#
+# Option +allow_duplicate_key+ specifies whether duplicate keys in objects
+# should be ignored or cause an error to be raised:
+#
+# When not specified:
+# # The last value is used and a deprecation warning emitted.
+# JSON.parse('{"a": 1, "a":2}') => {"a" => 2}
+# # warning: detected duplicate keys in JSON object.
+# # This will raise an error in json 3.0 unless enabled via `allow_duplicate_key: true`
+#
+# When set to +true+:
+# # The last value is used.
+# JSON.parse('{"a": 1, "a":2}') => {"a" => 2}
+#
+# When set to +false+, the future default:
+# JSON.parse('{"a": 1, "a":2}') => duplicate key at line 1 column 1 (JSON::ParserError)
+#
+# ---
+#
# Option +allow_nan+ (boolean) specifies whether to allow
# NaN, Infinity, and MinusInfinity in +source+;
# defaults to +false+.
@@ -183,8 +175,61 @@ end
# ruby = JSON.parse(source, {allow_nan: true})
# ruby # => [NaN, Infinity, -Infinity]
#
+# ---
+#
+# Option +allow_trailing_comma+ (boolean) specifies whether to allow
+# trailing commas in objects and arrays;
+# defaults to +false+.
+#
+# With the default, +false+:
+# JSON.parse('[1,]') # unexpected character: ']' at line 1 column 4 (JSON::ParserError)
+#
+# When enabled:
+# JSON.parse('[1,]', allow_trailing_comma: true) # => [1]
+#
+# ---
+#
+# Option +allow_comments+ (boolean) specifies whether to allow
+# JavaScript style comments (either // comment or /* comment */);
+# defaults to +false+.
+#
+# When not specified, a deprecation warning is emitted if a comment is encountered.
+#
+# When set to +true+, comments are ignored:
+# JSON.parse('/* comment */ {"a": 1, "a":2}') # => {"a" => 2}
+#
+# When set to +false+, the future default:
+# JSON.parse('/* comment */ {"a": 1, "a":2}') # unexpected character: '/' at line 1 column 1 (JSON::ParserError)
+#
+# ---
+#
+# Option +allow_control_characters+ (boolean) specifies whether to allow
+# unescaped ASCII control characters, such as newlines, in strings;
+# defaults to +false+.
+#
+# With the default, +false+:
+# JSON.parse(%{"Hello\nWorld"}) # invalid ASCII control character in string (JSON::ParserError)
+#
+# When enabled:
+# JSON.parse(%{"Hello\nWorld"}, allow_control_characters: true) # => "Hello\nWorld"
+#
+# ---
+#
+# Option +allow_invalid_escape+ (boolean) specifies whether to ignore backslahes that are followed
+# by an invalid escape character in strings;
+# defaults to +false+.
+#
+# With the default, +false+:
+# JSON.parse('"Hell\o"') # invalid escape character in string (JSON::ParserError)
+#
+# When enabled:
+# JSON.parse('"Hell\o"', allow_invalid_escape: true) # => "Hello"
+#
# ====== Output Options
#
+# Option +freeze+ (boolean) specifies whether the returned objects will be frozen;
+# defaults to +false+.
+#
# Option +symbolize_names+ (boolean) specifies whether returned \Hash keys
# should be Symbols;
# defaults to +false+ (use Strings).
@@ -309,8 +354,27 @@ end
# JSON.generate(JSON::MinusInfinity)
#
# Allow:
-# ruby = [Float::NaN, Float::Infinity, Float::MinusInfinity]
-# JSON.generate(ruby, allow_nan: true) # => '[NaN,Infinity,-Infinity]'
+# ruby = [Float::NAN, Float::INFINITY, JSON::NaN, JSON::Infinity, JSON::MinusInfinity]
+# JSON.generate(ruby, allow_nan: true) # => '[NaN,Infinity,NaN,Infinity,-Infinity]'
+#
+# ---
+#
+# Option +allow_duplicate_key+ (boolean) specifies whether
+# hashes with duplicate keys should be allowed or produce an error.
+# defaults to emit a deprecation warning.
+#
+# With the default, (not set):
+# Warning[:deprecated] = true
+# JSON.generate({ foo: 1, "foo" => 2 })
+# # warning: detected duplicate key "foo" in {foo: 1, "foo" => 2}.
+# # This will raise an error in json 3.0 unless enabled via `allow_duplicate_key: true`
+# # => '{"foo":1,"foo":2}'
+#
+# With false
+# JSON.generate({ foo: 1, "foo" => 2 }, allow_duplicate_key: false)
+# # detected duplicate key "foo" in {foo: 1, "foo" => 2} (JSON::GeneratorError)
+#
+# In version 3.0, false will become the default.
#
# ---
#
@@ -325,6 +389,15 @@ end
# # Raises JSON::NestingError (nesting of 2 is too deep):
# JSON.generate(obj, max_nesting: 2)
#
+# With +false+:
+# obj = []
+# obj[0] = obj
+# # Raises SystemStackError: stack level too deep
+# JSON.generate(obj, max_nesting: false)
+#
+# Setting +max_nesting+ to +false+ can lead to a stackoverflow and may leave the program
+# in an unrecoverable state. It is discouraged.
+#
# ====== Escaping Options
#
# Options +script_safe+ (boolean) specifies wether '\u2028', '\u2029'
@@ -349,7 +422,6 @@ end
# to be inserted after each \JSON object; defaults to the empty \String, ''.
# - Option +indent+ (\String) specifies the string (usually spaces) to be
# used for indentation; defaults to the empty \String, '';
-# defaults to the empty \String, '';
# has no effect unless options +array_nl+ or +object_nl+ specify newlines.
# - Option +space+ (\String) specifies a string (usually a space) to be
# inserted after the colon in each \JSON object's pair;
@@ -357,6 +429,11 @@ end
# - Option +space_before+ (\String) specifies a string (usually a space) to be
# inserted before the colon in each \JSON object's pair;
# defaults to the empty \String, ''.
+# - Option +sort_keys+ (boolean or \Proc) controls whether and how the keys of a
+# hash are sorted when generating the output; defaults to false.
+# When +true+, keys are sorted lexicographically. When a \Proc, it receives
+# the entire \Hash and must return a \Hash with its pairs in the desired
+# order, allowing for arbitrary sort orders.
#
# In this example, +obj+ is used first to generate the shortest
# \JSON data (no whitespace), then again with all formatting options
@@ -391,6 +468,9 @@ end
#
# == \JSON Additions
#
+# Note that JSON Additions must only be used with trusted data, and is
+# deprecated.
+#
# When you "round trip" a non-\String object from Ruby to \JSON and back,
# you have a new \String, instead of the object you began with:
# ruby0 = Range.new(0, 2)
@@ -653,7 +733,7 @@ module JSON
# Output:
# {"foo":[0,1],"bar":{"baz":2,"bat":3},"bam":"bad"}
#
- # source://json//lib/json/common.rb#823
+ # source://json//lib/json/common.rb#941
def dump(obj, anIO = T.unsafe(nil), limit = T.unsafe(nil), kwargs = T.unsafe(nil)); end
# :call-seq:
@@ -670,21 +750,18 @@ module JSON
# # Raises SystemStackError (stack level too deep):
# JSON.fast_generate(a)
#
- # source://json//lib/json/common.rb#357
+ # source://json//lib/json/common.rb#471
def fast_generate(obj, opts = T.unsafe(nil)); end
- # :stopdoc:
- # I want to deprecate these later, so I'll first be silent about them, and later delete them.
- #
- # source://json//lib/json/common.rb#357
- def fast_unparse(obj, opts = T.unsafe(nil)); end
+ # source://json//lib/json/common.rb#986
+ def fast_unparse(*_arg0, **_arg1, &_arg2); end
# :call-seq:
# JSON.generate(obj, opts = nil) -> new_string
#
# Returns a \String containing the generated \JSON data.
#
- # See also JSON.fast_generate, JSON.pretty_generate.
+ # See also JSON.pretty_generate.
#
# Argument +obj+ is the Ruby object to be converted to \JSON.
#
@@ -715,10 +792,11 @@ module JSON
# # Raises JSON::NestingError (nesting of 100 is too deep):
# JSON.generate(a)
#
- # source://json//lib/json/common.rb#329
+ # source://json//lib/json/common.rb#450
def generate(obj, opts = T.unsafe(nil)); end
# :call-seq:
+ # JSON.load(source, options = {}) -> object
# JSON.load(source, proc = nil, options = {}) -> object
#
# Returns the Ruby objects created by parsing the given +source+.
@@ -832,6 +910,7 @@ module JSON
# when Array
# obj.map! {|v| deserialize_obj v }
# end
+ # obj
# })
# pp ruby
# Output:
@@ -853,7 +932,7 @@ module JSON
# #"Admin", "password"=>"0wn3d"}>}
#
- # source://json//lib/json/common.rb#742
+ # source://json//lib/json/common.rb#865
def load(source, proc = T.unsafe(nil), options = T.unsafe(nil)); end
# :call-seq:
@@ -864,7 +943,7 @@ module JSON
#
# See method #parse.
#
- # source://json//lib/json/common.rb#278
+ # source://json//lib/json/common.rb#399
def load_file(filespec, opts = T.unsafe(nil)); end
# :call-seq:
@@ -875,7 +954,7 @@ module JSON
#
# See method #parse!
#
- # source://json//lib/json/common.rb#289
+ # source://json//lib/json/common.rb#410
def load_file!(filespec, opts = T.unsafe(nil)); end
# :call-seq:
@@ -926,7 +1005,7 @@ module JSON
# # Raises JSON::ParserError (783: unexpected token at ''):
# JSON.parse('')
#
- # source://json//lib/json/common.rb#247
+ # source://json//lib/json/common.rb#362
def parse(source, opts = T.unsafe(nil)); end
# :call-seq:
@@ -941,7 +1020,7 @@ module JSON
# which disables checking for nesting depth.
# - Option +allow_nan+, if not provided, defaults to +true+.
#
- # source://json//lib/json/common.rb#262
+ # source://json//lib/json/common.rb#384
def parse!(source, opts = T.unsafe(nil)); end
# :call-seq:
@@ -974,31 +1053,24 @@ module JSON
# }
# }
#
- # source://json//lib/json/common.rb#402
+ # source://json//lib/json/common.rb#518
def pretty_generate(obj, opts = T.unsafe(nil)); end
- # :stopdoc:
- # I want to deprecate these later, so I'll first be silent about them, and later delete them.
- #
- # source://json//lib/json/common.rb#402
- def pretty_unparse(obj, opts = T.unsafe(nil)); end
+ # source://json//lib/json/common.rb#996
+ def pretty_unparse(*_arg0, **_arg1, &_arg2); end
- # Recursively calls passed _Proc_ if the parsed data structure is an _Array_ or _Hash_
- #
- # source://json//lib/json/common.rb#768
- def recurse_proc(result, &proc); end
-
- # source://json//lib/json/common.rb#742
- def restore(source, proc = T.unsafe(nil), options = T.unsafe(nil)); end
+ # source://json//lib/json/common.rb#1006
+ def restore(*_arg0, **_arg1, &_arg2); end
# :stopdoc:
- # I want to deprecate these later, so I'll first be silent about them, and
- # later delete them.
+ # All these were meant to be deprecated circa 2009, but were just set as undocumented
+ # so usage still exist in the wild.
#
- # source://json//lib/json/common.rb#329
- def unparse(obj, opts = T.unsafe(nil)); end
+ # source://json//lib/json/common.rb#976
+ def unparse(*_arg0, **_arg1, &_arg2); end
# :call-seq:
+ # JSON.unsafe_load(source, options = {}) -> object
# JSON.unsafe_load(source, proc = nil, options = {}) -> object
#
# Returns the Ruby objects created by parsing the given +source+.
@@ -1106,6 +1178,7 @@ module JSON
# when Array
# obj.map! {|v| deserialize_obj v }
# end
+ # obj
# })
# pp ruby
# Output:
@@ -1127,7 +1200,7 @@ module JSON
# #"Admin", "password"=>"0wn3d"}>}
#
- # source://json//lib/json/common.rb#582
+ # source://json//lib/json/common.rb#694
def unsafe_load(source, proc = T.unsafe(nil), options = T.unsafe(nil)); end
class << self
@@ -1143,35 +1216,24 @@ module JSON
# ruby = [0, 1, nil]
# JSON[ruby] # => '[0,1,null]'
#
- # source://json//lib/json/common.rb#23
+ # source://json//lib/json/common.rb#132
def [](object, opts = T.unsafe(nil)); end
- # source://json//lib/json/common.rb#80
- def create_fast_state; end
-
# Returns the current create identifier.
# See also JSON.create_id=.
#
- # source://json//lib/json/common.rb#115
+ # source://json//lib/json/common.rb#245
def create_id; end
# Sets create identifier, which is used to decide if the _json_create_
# hook of a class should be called; initial value is +json_class+:
# JSON.create_id # => 'json_class'
#
- # source://json//lib/json/common.rb#109
+ # source://json//lib/json/common.rb#239
def create_id=(new_value); end
- # source://json//lib/json/common.rb#90
- def create_pretty_state; end
-
- # Return the constant located at _path_. The format of _path_ has to be
- # either ::A::B::C or A::B::C. In any case, A has to be located at the top
- # level (absolute namespace path?). If there doesn't exist a constant at
- # the given path, an ArgumentError is raised.
- #
- # source://json//lib/json/common.rb#50
- def deep_const_get(path); end
+ # source://json//lib/json/common.rb#104
+ def deprecation_warning(message, uplevel = T.unsafe(nil)); end
# :call-seq:
# JSON.dump(obj, io = nil, limit = nil)
@@ -1201,25 +1263,9 @@ module JSON
# Output:
# {"foo":[0,1],"bar":{"baz":2,"bat":3},"bam":"bad"}
#
- # source://json//lib/json/common.rb#823
+ # source://json//lib/json/common.rb#941
def dump(obj, anIO = T.unsafe(nil), limit = T.unsafe(nil), kwargs = T.unsafe(nil)); end
- # Sets or returns the default options for the JSON.dump method.
- # Initially:
- # opts = JSON.dump_default_options
- # opts # => {:max_nesting=>false, :allow_nan=>true}
- #
- # source://json//lib/json/common.rb#789
- def dump_default_options; end
-
- # Sets or returns the default options for the JSON.dump method.
- # Initially:
- # opts = JSON.dump_default_options
- # opts # => {:max_nesting=>false, :allow_nan=>true}
- #
- # source://json//lib/json/common.rb#789
- def dump_default_options=(_arg0); end
-
# :call-seq:
# JSON.fast_generate(obj, opts) -> new_string
#
@@ -1234,21 +1280,18 @@ module JSON
# # Raises SystemStackError (stack level too deep):
# JSON.fast_generate(a)
#
- # source://json//lib/json/common.rb#357
+ # source://json//lib/json/common.rb#471
def fast_generate(obj, opts = T.unsafe(nil)); end
- # :stopdoc:
- # I want to deprecate these later, so I'll first be silent about them, and later delete them.
- #
- # source://json//lib/json/common.rb#357
- def fast_unparse(obj, opts = T.unsafe(nil)); end
+ # source://json//lib/json/common.rb#986
+ def fast_unparse(*_arg0, **_arg1, &_arg2); end
# :call-seq:
# JSON.generate(obj, opts = nil) -> new_string
#
# Returns a \String containing the generated \JSON data.
#
- # See also JSON.fast_generate, JSON.pretty_generate.
+ # See also JSON.pretty_generate.
#
# Argument +obj+ is the Ruby object to be converted to \JSON.
#
@@ -1279,25 +1322,21 @@ module JSON
# # Raises JSON::NestingError (nesting of 100 is too deep):
# JSON.generate(a)
#
- # source://json//lib/json/common.rb#329
+ # source://json//lib/json/common.rb#450
def generate(obj, opts = T.unsafe(nil)); end
# Returns the JSON generator module that is used by JSON.
#
- # source://json//lib/json/common.rb#100
+ # source://json//lib/json/common.rb#188
def generator; end
# Set the module _generator_ to be used by JSON.
#
- # source://json//lib/json/common.rb#57
+ # source://json//lib/json/common.rb#156
def generator=(generator); end
- # Encodes string using String.encode.
- #
- # source://json//lib/json/common.rb#856
- def iconv(to, from, string); end
-
# :call-seq:
+ # JSON.load(source, options = {}) -> object
# JSON.load(source, proc = nil, options = {}) -> object
#
# Returns the Ruby objects created by parsing the given +source+.
@@ -1411,6 +1450,7 @@ module JSON
# when Array
# obj.map! {|v| deserialize_obj v }
# end
+ # obj
# })
# pp ruby
# Output:
@@ -1432,25 +1472,9 @@ module JSON
# #"Admin", "password"=>"0wn3d"}>}
#
- # source://json//lib/json/common.rb#742
+ # source://json//lib/json/common.rb#865
def load(source, proc = T.unsafe(nil), options = T.unsafe(nil)); end
- # Sets or returns default options for the JSON.load method.
- # Initially:
- # opts = JSON.load_default_options
- # opts # => {:max_nesting=>false, :allow_nan=>true, :allow_blank=>true, :create_additions=>true}
- #
- # source://json//lib/json/common.rb#446
- def load_default_options; end
-
- # Sets or returns default options for the JSON.load method.
- # Initially:
- # opts = JSON.load_default_options
- # opts # => {:max_nesting=>false, :allow_nan=>true, :allow_blank=>true, :create_additions=>true}
- #
- # source://json//lib/json/common.rb#446
- def load_default_options=(_arg0); end
-
# :call-seq:
# JSON.load_file(path, opts={}) -> object
#
@@ -1459,7 +1483,7 @@ module JSON
#
# See method #parse.
#
- # source://json//lib/json/common.rb#278
+ # source://json//lib/json/common.rb#399
def load_file(filespec, opts = T.unsafe(nil)); end
# :call-seq:
@@ -1470,7 +1494,7 @@ module JSON
#
# See method #parse!
#
- # source://json//lib/json/common.rb#289
+ # source://json//lib/json/common.rb#410
def load_file!(filespec, opts = T.unsafe(nil)); end
# :call-seq:
@@ -1521,7 +1545,7 @@ module JSON
# # Raises JSON::ParserError (783: unexpected token at ''):
# JSON.parse('')
#
- # source://json//lib/json/common.rb#247
+ # source://json//lib/json/common.rb#362
def parse(source, opts = T.unsafe(nil)); end
# :call-seq:
@@ -1536,17 +1560,17 @@ module JSON
# which disables checking for nesting depth.
# - Option +allow_nan+, if not provided, defaults to +true+.
#
- # source://json//lib/json/common.rb#262
+ # source://json//lib/json/common.rb#384
def parse!(source, opts = T.unsafe(nil)); end
# Returns the JSON parser class that is used by JSON.
#
- # source://json//lib/json/common.rb#37
+ # source://json//lib/json/common.rb#146
def parser; end
# Set the JSON parser class _parser_ to be used by JSON.
#
- # source://json//lib/json/common.rb#40
+ # source://json//lib/json/common.rb#149
def parser=(parser); end
# :call-seq:
@@ -1579,41 +1603,34 @@ module JSON
# }
# }
#
- # source://json//lib/json/common.rb#402
+ # source://json//lib/json/common.rb#518
def pretty_generate(obj, opts = T.unsafe(nil)); end
- # :stopdoc:
- # I want to deprecate these later, so I'll first be silent about them, and later delete them.
- #
- # source://json//lib/json/common.rb#402
- def pretty_unparse(obj, opts = T.unsafe(nil)); end
+ # source://json//lib/json/common.rb#996
+ def pretty_unparse(*_arg0, **_arg1, &_arg2); end
- # Recursively calls passed _Proc_ if the parsed data structure is an _Array_ or _Hash_
- #
- # source://json//lib/json/common.rb#768
- def recurse_proc(result, &proc); end
-
- # source://json//lib/json/common.rb#742
- def restore(source, proc = T.unsafe(nil), options = T.unsafe(nil)); end
+ # source://json//lib/json/common.rb#1006
+ def restore(*_arg0, **_arg1, &_arg2); end
# Sets or Returns the JSON generator state class that is used by JSON.
#
- # source://json//lib/json/common.rb#103
+ # source://json//lib/json/common.rb#191
def state; end
# Sets or Returns the JSON generator state class that is used by JSON.
#
- # source://json//lib/json/common.rb#103
+ # source://json//lib/json/common.rb#191
def state=(_arg0); end
# :stopdoc:
- # I want to deprecate these later, so I'll first be silent about them, and
- # later delete them.
+ # All these were meant to be deprecated circa 2009, but were just set as undocumented
+ # so usage still exist in the wild.
#
- # source://json//lib/json/common.rb#329
- def unparse(obj, opts = T.unsafe(nil)); end
+ # source://json//lib/json/common.rb#976
+ def unparse(*_arg0, **_arg1, &_arg2); end
# :call-seq:
+ # JSON.unsafe_load(source, options = {}) -> object
# JSON.unsafe_load(source, proc = nil, options = {}) -> object
#
# Returns the Ruby objects created by parsing the given +source+.
@@ -1721,6 +1738,7 @@ module JSON
# when Array
# obj.map! {|v| deserialize_obj v }
# end
+ # obj
# })
# pp ruby
# Output:
@@ -1742,24 +1760,21 @@ module JSON
# #"Admin", "password"=>"0wn3d"}>}
#
- # source://json//lib/json/common.rb#582
+ # source://json//lib/json/common.rb#694
def unsafe_load(source, proc = T.unsafe(nil), options = T.unsafe(nil)); end
- # Sets or returns default options for the JSON.unsafe_load method.
- # Initially:
- # opts = JSON.load_default_options
- # opts # => {:max_nesting=>false, :allow_nan=>true, :allow_blank=>true, :create_additions=>true}
- #
- # source://json//lib/json/common.rb#432
- def unsafe_load_default_options; end
+ private
- # Sets or returns default options for the JSON.unsafe_load method.
- # Initially:
- # opts = JSON.load_default_options
- # opts # => {:max_nesting=>false, :allow_nan=>true, :allow_blank=>true, :create_additions=>true}
+ # source://json//lib/json/common.rb#1019
+ def const_missing(const_name); end
+
+ # source://json//lib/json/common.rb#214
+ def deprecated_singleton_attr_accessor(*attrs); end
+
+ # Called from the extension when a hash has both string and symbol keys
#
- # source://json//lib/json/common.rb#432
- def unsafe_load_default_options=(_arg0); end
+ # source://json//lib/json/common.rb#196
+ def on_mixed_keys_hash(hash, do_raise); end
end
end
@@ -1773,16 +1788,17 @@ end
#
# MyApp::JSONC_CODER.load(document)
#
-# source://json//lib/json/common.rb#870
+# source://json//lib/json/common.rb#1045
class JSON::Coder
# :call-seq:
# JSON.new(options = nil, &block)
#
# Argument +options+, if given, contains a \Hash of options for both parsing and generating.
- # See {Parsing Options}[#module-JSON-label-Parsing+Options], and {Generating Options}[#module-JSON-label-Generating+Options].
+ # See {Parsing Options}[rdoc-ref:JSON@Parsing+Options],
+ # and {Generating Options}[rdoc-ref:JSON@Generating+Options].
#
# For generation, the strict: true option is always set. When a Ruby object with no native \JSON counterpart is
- # encoutered, the block provided to the initialize method is invoked, and must return a Ruby object that has a native
+ # encountered, the block provided to the initialize method is invoked, and must return a Ruby object that has a native
# \JSON counterpart:
#
# module MyApp
@@ -1800,7 +1816,7 @@ class JSON::Coder
#
# @return [Coder] a new instance of Coder
#
- # source://json//lib/json/common.rb#894
+ # source://json//lib/json/common.rb#1070
def initialize(options = T.unsafe(nil), &as_json); end
# call-seq:
@@ -1809,7 +1825,7 @@ class JSON::Coder
#
# Serialize the given object into a \JSON document.
#
- # source://json//lib/json/common.rb#913
+ # source://json//lib/json/common.rb#1088
def dump(object, io = T.unsafe(nil)); end
# call-seq:
@@ -1818,7 +1834,7 @@ class JSON::Coder
#
# Serialize the given object into a \JSON document.
#
- # source://json//lib/json/common.rb#913
+ # source://json//lib/json/common.rb#1088
def generate(object, io = T.unsafe(nil)); end
# call-seq:
@@ -1826,7 +1842,7 @@ class JSON::Coder
#
# Parse the given \JSON document and return an equivalent Ruby object.
#
- # source://json//lib/json/common.rb#922
+ # source://json//lib/json/common.rb#1097
def load(source); end
# call-seq:
@@ -1834,7 +1850,7 @@ class JSON::Coder
#
# Parse the given \JSON document and return an equivalent Ruby object.
#
- # source://json//lib/json/common.rb#931
+ # source://json//lib/json/common.rb#1106
def load_file(path); end
# call-seq:
@@ -1842,52 +1858,36 @@ class JSON::Coder
#
# Parse the given \JSON document and return an equivalent Ruby object.
#
- # source://json//lib/json/common.rb#922
+ # source://json//lib/json/common.rb#1097
def parse(source); end
end
-module JSON::Ext::Generator::GeneratorMethods::String
- mixes_in_class_methods ::JSON::Ext::Generator::GeneratorMethods::String::Extend
-end
-
# source://json//lib/json/ext/generator/state.rb#6
class JSON::Ext::Generator::State
# call-seq: new(opts = {})
#
# Instantiates a new State object, configured by _opts_.
#
- # _opts_ can have the following keys:
- #
- # * *indent*: a string used to indent levels (default: ''),
- # * *space*: a string that is put after, a : or , delimiter (default: ''),
- # * *space_before*: a string that is put before a : pair delimiter (default: ''),
- # * *object_nl*: a string that is put at the end of a JSON object (default: ''),
- # * *array_nl*: a string that is put at the end of a JSON array (default: ''),
- # * *allow_nan*: true if NaN, Infinity, and -Infinity should be
- # generated, otherwise an exception is thrown, if these values are
- # encountered. This options defaults to false.
- # * *ascii_only*: true if only ASCII characters should be generated. This
- # option defaults to false.
- # * *buffer_initial_length*: sets the initial length of the generator's
- # internal buffer.
+ # Argument +opts+, if given, contains a \Hash of options for the generation.
+ # See {Generating Options}[rdoc-ref:JSON@Generating+Options].
#
# @return [State] a new instance of State
#
- # source://json//lib/json/ext/generator/state.rb#25
+ # source://json//lib/json/ext/generator/state.rb#13
def initialize(opts = T.unsafe(nil)); end
# call-seq: [](name)
#
# Returns the value returned by method +name+.
#
- # source://json//lib/json/ext/generator/state.rb#84
+ # source://json//lib/json/ext/generator/state.rb#78
def [](name); end
# call-seq: []=(name, value)
#
# Sets the attribute name to value.
#
- # source://json//lib/json/ext/generator/state.rb#96
+ # source://json//lib/json/ext/generator/state.rb#92
def []=(name, value); end
# call-seq: configure(opts)
@@ -1895,7 +1895,7 @@ class JSON::Ext::Generator::State
# Configure this State instance with the Hash _opts_, and return
# itself.
#
- # source://json//lib/json/ext/generator/state.rb#35
+ # source://json//lib/json/ext/generator/state.rb#23
def configure(opts); end
# call-seq: configure(opts)
@@ -1903,7 +1903,7 @@ class JSON::Ext::Generator::State
# Configure this State instance with the Hash _opts_, and return
# itself.
#
- # source://json//lib/json/ext/generator/state.rb#35
+ # source://json//lib/json/ext/generator/state.rb#23
def merge(opts); end
# call-seq: to_h
@@ -1911,7 +1911,7 @@ class JSON::Ext::Generator::State
# Returns the configuration instance variables as a hash, that can be
# passed to the configure method.
#
- # source://json//lib/json/ext/generator/state.rb#54
+ # source://json//lib/json/ext/generator/state.rb#42
def to_h; end
# call-seq: to_h
@@ -1919,7 +1919,7 @@ class JSON::Ext::Generator::State
# Returns the configuration instance variables as a hash, that can be
# passed to the configure method.
#
- # source://json//lib/json/ext/generator/state.rb#54
+ # source://json//lib/json/ext/generator/state.rb#42
def to_hash; end
end
@@ -1949,13 +1949,13 @@ JSON::Ext::Parser::Config = JSON::Ext::ParserConfig
# to string interpolation.
#
# Note: no validation is performed on the provided string. It is the
-# responsability of the caller to ensure the string contains valid JSON.
+# responsibility of the caller to ensure the string contains valid JSON.
#
-# source://json//lib/json/common.rb#183
+# source://json//lib/json/common.rb#298
class JSON::Fragment < ::Struct
# @return [Fragment] a new instance of Fragment
#
- # source://json//lib/json/common.rb#184
+ # source://json//lib/json/common.rb#299
def initialize(json); end
# Returns the value of attribute json
@@ -1969,7 +1969,7 @@ class JSON::Fragment < ::Struct
# @return [Object] the newly set value
def json=(_); end
- # source://json//lib/json/common.rb#192
+ # source://json//lib/json/common.rb#307
def to_json(state = T.unsafe(nil), *_arg1); end
class << self
@@ -1983,88 +1983,129 @@ end
# This exception is raised if a generator or unparser error occurs.
#
-# source://json//lib/json/common.rb#146
+# source://json//lib/json/common.rb#268
class JSON::GeneratorError < ::JSON::JSONError
# @return [GeneratorError] a new instance of GeneratorError
#
- # source://json//lib/json/common.rb#149
+ # source://json//lib/json/common.rb#271
def initialize(message, invalid_object = T.unsafe(nil)); end
- # source://json//lib/json/common.rb#154
+ # source://json//lib/json/common.rb#276
def detailed_message(*_arg0, **_arg1, &_arg2); end
# Returns the value of attribute invalid_object.
#
- # source://json//lib/json/common.rb#147
+ # source://json//lib/json/common.rb#269
def invalid_object; end
end
-# source://json//lib/json/generic_object.rb#9
-class JSON::GenericObject < ::OpenStruct
- # source://json//lib/json/generic_object.rb#67
- def as_json(*_arg0); end
+# source://json//lib/json/common.rb#1111
+module JSON::GeneratorMethods
+ # call-seq: to_json(*)
+ #
+ # Converts this object into a JSON string.
+ # If this object doesn't directly maps to a JSON native type,
+ # first convert it to a string (calling #to_s), then converts
+ # it to a JSON string, and returns the result.
+ # This is a fallback, if no special method #to_json was defined for some object.
+ #
+ # source://json//lib/json/common.rb#1119
+ def to_json(state = T.unsafe(nil), *_arg1); end
+end
- # source://json//lib/json/generic_object.rb#51
- def to_hash; end
+# source://json//lib/json/common.rb#367
+JSON::PARSE_L_OPTIONS = T.let(T.unsafe(nil), Hash)
- # source://json//lib/json/generic_object.rb#71
- def to_json(*a); end
+# source://json//lib/json/common.rb#480
+JSON::PRETTY_GENERATE_OPTIONS = T.let(T.unsafe(nil), Hash)
- # source://json//lib/json/generic_object.rb#63
- def |(other); end
+# source://json//lib/json/common.rb#152
+JSON::Parser = JSON::Ext::Parser
+# This exception is raised if a parser error occurs.
+#
+# source://json//lib/json/common.rb#259
+class JSON::ParserError < ::JSON::JSONError
+ # Returns the value of attribute column.
+ #
+ # source://json//lib/json/common.rb#260
+ def column; end
+
+ # Returns the value of attribute line.
+ #
+ # source://json//lib/json/common.rb#260
+ def line; end
+end
+
+# source://json//lib/json/common.rb#8
+module JSON::ParserOptions
class << self
- # source://json//lib/json/generic_object.rb#45
- def dump(obj, *args); end
+ # source://json//lib/json/common.rb#10
+ def prepare(opts); end
- # source://json//lib/json/generic_object.rb#25
- def from_hash(object); end
+ private
- # Sets the attribute json_creatable
- #
- # @param value the value to set the attribute json_creatable to.
- #
- # source://json//lib/json/generic_object.rb#17
- def json_creatable=(_arg0); end
+ # source://json//lib/json/common.rb#40
+ def array_class_proc(array_class, on_load); end
- # @return [Boolean]
+ # TODO: extract :create_additions support to another gem for version 3.0
#
- # source://json//lib/json/generic_object.rb#13
- def json_creatable?; end
+ # source://json//lib/json/common.rb#52
+ def create_additions_proc(opts); end
- # source://json//lib/json/generic_object.rb#19
- def json_create(data); end
+ # source://json//lib/json/common.rb#95
+ def create_additions_warning; end
- # source://json//lib/json/generic_object.rb#40
- def load(source, proc = T.unsafe(nil), opts = T.unsafe(nil)); end
+ # source://json//lib/json/common.rb#29
+ def object_class_proc(object_class, on_load); end
end
end
-# The base exception for JSON errors.
-#
-# source://json//lib/json/common.rb#126
-class JSON::JSONError < ::StandardError
- class << self
- # source://json//lib/json/common.rb#127
- def wrap(exception); end
- end
-end
+# source://json//lib/json/ext.rb#45
+class JSON::ResumableParser
+ def initialize(*_arg0); end
-# source://json//lib/json/common.rb#8
-JSON::NOT_SET = T.let(T.unsafe(nil), Object)
+ def <<(_arg0); end
+ def clear; end
-# source://json//lib/json/common.rb#43
-JSON::Parser = JSON::Ext::Parser
+ # Returns whether the parser is entirely done: no unconsumed bytes in
+ # the buffer, no document under construction and no parsed value
+ # awaiting retrieval.
+ #
+ # The main use case is detecting a truncated stream once the input is
+ # exhausted:
+ #
+ # loop do
+ # begin
+ # parser << socket.readpartial(4096)
+ # rescue EOFError
+ # break
+ # end
+ # while parser.parse
+ # process(parser.value)
+ # end
+ # end
+ # warn "stream was truncated" unless parser.empty?
+ #
+ # @return [Boolean]
+ #
+ # source://json//lib/json/ext.rb#64
+ def empty?; end
-# source://json//lib/json/common.rb#72
-JSON::State = JSON::Ext::Generator::State
+ def eos?; end
+ def parse; end
+ def parsed_bytes; end
+ def partial_value; end
+ def partial_value?; end
+ def rest; end
+ def value; end
+ def value?; end
+end
-# For backwards compatibility
-#
-# source://json//lib/json/common.rb#167
-JSON::UnparserError = JSON::GeneratorError
+# source://json//lib/json/common.rb#182
+JSON::State = JSON::Ext::Generator::State
-# source://json//lib/json/common.rb#937
+# source://json//lib/json/common.rb#1136
module Kernel
private
@@ -2075,38 +2116,25 @@ module Kernel
# The _opts_ argument is passed through to generate/parse respectively. See
# generate and parse for their documentation.
#
- # source://json//lib/json/common.rb#964
- def JSON(object, *args); end
+ # source://json//lib/json/common.rb#1175
+ def JSON(object, opts = T.unsafe(nil)); end
# Outputs _objs_ to STDOUT as JSON strings in the shortest form, that is in
# one line.
#
- # source://json//lib/json/common.rb#942
+ # source://json//lib/json/common.rb#1141
def j(*objs); end
# Outputs _objs_ to STDOUT as JSON strings in a pretty format, with
# indentation and over many lines.
#
- # source://json//lib/json/common.rb#951
+ # source://json//lib/json/common.rb#1156
def jj(*objs); end
end
-class NilClass
- include ::JSON::Ext::Generator::GeneratorMethods::NilClass
-end
-
+# source://json//lib/json/common.rb#1180
class Object < ::BasicObject
include ::Kernel
include ::PP::ObjectMixin
- include ::JSON::Ext::Generator::GeneratorMethods::Object
-end
-
-class String
- include ::Comparable
- include ::JSON::Ext::Generator::GeneratorMethods::String
- extend ::JSON::Ext::Generator::GeneratorMethods::String::Extend
-end
-
-class TrueClass
- include ::JSON::Ext::Generator::GeneratorMethods::TrueClass
+ include ::JSON::GeneratorMethods
end
diff --git a/sub_projects/sorbet_user/sorbet/rbi/gems/yard@0.9.37.rbi b/sub_projects/sorbet_user/sorbet/rbi/gems/yard@0.9.45.rbi
similarity index 91%
rename from sub_projects/sorbet_user/sorbet/rbi/gems/yard@0.9.37.rbi
rename to sub_projects/sorbet_user/sorbet/rbi/gems/yard@0.9.45.rbi
index b7622a2..6622d29 100644
--- a/sub_projects/sorbet_user/sorbet/rbi/gems/yard@0.9.37.rbi
+++ b/sub_projects/sorbet_user/sorbet/rbi/gems/yard@0.9.45.rbi
@@ -1,4 +1,4 @@
-# typed: true
+# typed: false
# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `yard` gem.
@@ -284,50 +284,81 @@ class Gem::SourceIndex
end
# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#17
+module IRB::DebugLogger
+ class << self
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#18
+ def pp(*args); end
+ end
+end
+
+# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#21
+module IRB::Notifier
+ class << self
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#23
+ def def_notifier(*args); end
+
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#25
+ def exec_if(*args, &block); end
+
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#28
+ def level=(value); end
+
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#24
+ def pp(*args); end
+
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#26
+ def printf(*args); end
+
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#27
+ def puts(*args); end
+ end
+end
+
+# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#35
class IRB::SLex
# @return [SLex] a new instance of SLex
#
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#25
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#43
def initialize; end
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#60
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#78
def create(token, preproc = T.unsafe(nil), postproc = T.unsafe(nil)); end
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#29
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#47
def def_rule(token, preproc = T.unsafe(nil), postproc = T.unsafe(nil), &block); end
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#36
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#54
def def_rules(*tokens, &block); end
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#77
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#95
def inspect; end
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#64
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#82
def match(token); end
# need a check?
#
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#51
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#69
def postproc(token); end
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#45
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#63
def preproc(token, proc); end
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#56
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#74
def search(token); end
end
-# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#18
-IRB::SLex::DOUT = T.let(T.unsafe(nil), IRB::Notifier::CompositeNotifier)
+# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#36
+IRB::SLex::DOUT = IRB::Notifier
-# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#20
-IRB::SLex::D_DEBUG = T.let(T.unsafe(nil), IRB::Notifier::LeveledNotifier)
+# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#38
+IRB::SLex::D_DEBUG = IRB::Notifier
-# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#21
-IRB::SLex::D_DETAIL = T.let(T.unsafe(nil), IRB::Notifier::LeveledNotifier)
+# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#39
+IRB::SLex::D_DETAIL = IRB::Notifier
-# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#19
-IRB::SLex::D_WARN = T.let(T.unsafe(nil), IRB::Notifier::LeveledNotifier)
+# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#37
+IRB::SLex::D_WARN = IRB::Notifier
# ----------------------------------------------------------------------
#
@@ -335,17 +366,17 @@ IRB::SLex::D_WARN = T.let(T.unsafe(nil), IRB::Notifier::LeveledNotifier)
#
# ----------------------------------------------------------------------
#
-# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#86
+# source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#104
class IRB::SLex::Node
# if postproc is nil, this node is an abstract node.
# if postproc is non-nil, this node is a real node.
#
# @return [Node] a new instance of Node
#
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#89
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#107
def initialize(preproc = T.unsafe(nil), postproc = T.unsafe(nil)); end
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#113
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#131
def create_subnode(chrs, preproc = T.unsafe(nil), postproc = T.unsafe(nil)); end
# chrs: String
@@ -353,37 +384,37 @@ class IRB::SLex::Node
# io must have getc()/ungetc(); and ungetc() must be
# able to be called arbitrary number of times.
#
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#161
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#179
def match(chrs, op = T.unsafe(nil)); end
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#198
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#216
def match_io(io, op = T.unsafe(nil)); end
# Returns the value of attribute postproc.
#
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#96
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#114
def postproc; end
# Sets the attribute postproc
#
# @param value the value to set the attribute postproc to.
#
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#96
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#114
def postproc=(_arg0); end
# Returns the value of attribute preproc.
#
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#95
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#113
def preproc; end
# Sets the attribute preproc
#
# @param value the value to set the attribute preproc to.
#
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#95
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#113
def preproc=(_arg0); end
- # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#98
+ # source://yard//lib/yard/parser/ruby/legacy/irb/slex.rb#116
def search(chrs, opt = T.unsafe(nil)); end
end
@@ -599,12 +630,7 @@ end
# source://yard//lib/yard.rb#2
module YARD
class << self
- # Loads gems that match the name 'yard-*' (recommended) or 'yard_*' except
- # those listed in +~/.yard/ignored_plugins+. This is called immediately
- # after YARD is loaded to allow plugin support.
- #
# @deprecated Use {Config.load_plugins}
- # @return [Boolean] true if all plugins loaded successfully, false otherwise.
#
# source://yard//lib/yard.rb#31
def load_plugins; end
@@ -944,84 +970,84 @@ end
#
# @since 0.6.0
#
-# source://yard//lib/yard/cli/diff.rb#11
+# source://yard//lib/yard/cli/diff.rb#12
class YARD::CLI::Diff < ::YARD::CLI::Command
# @return [Diff] a new instance of Diff
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#12
+ # source://yard//lib/yard/cli/diff.rb#13
def initialize; end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#24
+ # source://yard//lib/yard/cli/diff.rb#25
def description; end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#28
+ # source://yard//lib/yard/cli/diff.rb#29
def run(*args); end
private
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#83
+ # source://yard//lib/yard/cli/diff.rb#84
def added_objects(registry1, registry2); end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#78
+ # source://yard//lib/yard/cli/diff.rb#79
def all_objects; end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#233
+ # source://yard//lib/yard/cli/diff.rb#238
def cleanup(gemfile); end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#175
+ # source://yard//lib/yard/cli/diff.rb#180
def expand_and_parse(gemfile, io); end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#187
+ # source://yard//lib/yard/cli/diff.rb#192
def expand_gem(gemfile, io); end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#181
+ # source://yard//lib/yard/cli/diff.rb#186
def generate_yardoc(dir); end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#118
+ # source://yard//lib/yard/cli/diff.rb#123
def load_gem_data(gemfile); end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#102
+ # source://yard//lib/yard/cli/diff.rb#103
def load_git_commit(commit); end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#87
+ # source://yard//lib/yard/cli/diff.rb#88
def modified_objects(registry1, registry2); end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#239
+ # source://yard//lib/yard/cli/diff.rb#244
def optparse(*args); end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#98
+ # source://yard//lib/yard/cli/diff.rb#99
def removed_objects(registry1, registry2); end
# @since 0.6.0
#
- # source://yard//lib/yard/cli/diff.rb#225
+ # source://yard//lib/yard/cli/diff.rb#230
def require_rubygems; end
end
@@ -2464,7 +2490,7 @@ class YARD::CodeObjects::Base
# @example Create class Z inside namespace X::Y
# CodeObjects::Base.new(P("X::Y"), :Z) # or
# CodeObjects::Base.new(Registry.root, "X::Y")
- # @param namespace [NamespaceObject] the namespace the object belongs in,
+ # @param namespace [NamespaceObject, :root, nil] the namespace the object belongs in,
# {Registry.root} or :root should be provided if it is associated with
# the top level namespace.
# @param name [Symbol, String] the name (or complex path) of the object.
@@ -4116,7 +4142,7 @@ class YARD::CodeObjects::Proxy
# source://yard//lib/yard/code_objects/proxy.rb#228
def proxy_path; end
- # @note this method fixes a bug in 1.9.2: http://gist.github.com/437136
+ # @note this method fixes a bug in 1.9.2: https://gist.github.com/437136
#
# source://yard//lib/yard/code_objects/proxy.rb#205
def to_ary; end
@@ -5234,7 +5260,7 @@ class YARD::Handlers::Base
# @raise [NotImplementedError]
# @return [Array] a list of argument names
#
- # source://yard//lib/yard/handlers/base.rb#581
+ # source://yard//lib/yard/handlers/base.rb#603
def call_params; end
# @abstract Implement this method to return the method being called in
@@ -5244,7 +5270,7 @@ class YARD::Handlers::Base
# @return [String] the method name being called
# @return [nil] if the statement is not a method call
#
- # source://yard//lib/yard/handlers/base.rb#590
+ # source://yard//lib/yard/handlers/base.rb#612
def caller_method; end
# Ensures that a specific +object+ has been parsed and loaded into the
@@ -5267,7 +5293,7 @@ class YARD::Handlers::Base
# +max_retries+ attempts, this exception is raised and the handler
# finishes processing.
#
- # source://yard//lib/yard/handlers/base.rb#561
+ # source://yard//lib/yard/handlers/base.rb#583
def ensure_loaded!(object, max_retries = T.unsafe(nil)); end
# Returns the value of attribute extra_state.
@@ -5376,7 +5402,7 @@ class YARD::Handlers::Base
# @return [void]
# @since 0.8.0
#
- # source://yard//lib/yard/handlers/base.rb#537
+ # source://yard//lib/yard/handlers/base.rb#559
def register_dynamic(object); end
# Ensures that the object's namespace is loaded before attaching it
@@ -5404,7 +5430,7 @@ class YARD::Handlers::Base
# @return [void]
# @since 0.8.0
#
- # source://yard//lib/yard/handlers/base.rb#473
+ # source://yard//lib/yard/handlers/base.rb#485
def register_group(object, group = T.unsafe(nil)); end
# Registers the same method information on the module function, if
@@ -5414,14 +5440,14 @@ class YARD::Handlers::Base
# to copy data for
# @since 0.8.0
#
- # source://yard//lib/yard/handlers/base.rb#523
+ # source://yard//lib/yard/handlers/base.rb#545
def register_module_function(object); end
# @param object [CodeObjects::Base] the object to register
# @return [void]
# @since 0.8.0
#
- # source://yard//lib/yard/handlers/base.rb#499
+ # source://yard//lib/yard/handlers/base.rb#511
def register_source(object, source = T.unsafe(nil), type = T.unsafe(nil)); end
# Registers any transitive tags from the namespace on the object
@@ -5430,7 +5456,7 @@ class YARD::Handlers::Base
# @return [void]
# @since 0.8.0
#
- # source://yard//lib/yard/handlers/base.rb#487
+ # source://yard//lib/yard/handlers/base.rb#499
def register_transitive_tags(object); end
# Registers visibility on a method object. If the object does not
@@ -5440,7 +5466,7 @@ class YARD::Handlers::Base
# @param visibility [Symbol] the visibility to set on the object
# @since 0.8.0
#
- # source://yard//lib/yard/handlers/base.rb#511
+ # source://yard//lib/yard/handlers/base.rb#523
def register_visibility(object, visibility = T.unsafe(nil)); end
# Returns the value of attribute scope.
@@ -5583,7 +5609,7 @@ end
#
# @since 0.8.0
#
-# source://yard//lib/yard/autoload.rb#74
+# source://yard//lib/yard/autoload.rb#84
module YARD::Handlers::C; end
# @since 0.8.0
@@ -5961,7 +5987,7 @@ class YARD::Handlers::Processor
# @param parser [Parser::SourceParser] the parser used to initialize the processor
# @return [Processor] a new instance of Processor
#
- # source://yard//lib/yard/handlers/processor.rb#91
+ # source://yard//lib/yard/handlers/processor.rb#92
def initialize(parser); end
# Share state across different handlers inside of a file.
@@ -5974,7 +6000,7 @@ class YARD::Handlers::Processor
# @return [OpenStruct] an open structure that can store arbitrary data
# @see #globals
#
- # source://yard//lib/yard/handlers/processor.rb#87
+ # source://yard//lib/yard/handlers/processor.rb#88
def extra_state; end
# Share state across different handlers inside of a file.
@@ -5987,17 +6013,17 @@ class YARD::Handlers::Processor
# @return [OpenStruct] an open structure that can store arbitrary data
# @see #globals
#
- # source://yard//lib/yard/handlers/processor.rb#87
+ # source://yard//lib/yard/handlers/processor.rb#88
def extra_state=(_arg0); end
# @return [String] the filename
#
- # source://yard//lib/yard/handlers/processor.rb#40
+ # source://yard//lib/yard/handlers/processor.rb#41
def file; end
# @return [String] the filename
#
- # source://yard//lib/yard/handlers/processor.rb#40
+ # source://yard//lib/yard/handlers/processor.rb#41
def file=(_arg0); end
# Searches for all handlers in {Base.subclasses} that match the +statement+
@@ -6005,7 +6031,7 @@ class YARD::Handlers::Processor
# @param statement the statement object to match.
# @return [Array] a list of handlers to process the statement with.
#
- # source://yard//lib/yard/handlers/processor.rb#150
+ # source://yard//lib/yard/handlers/processor.rb#151
def find_handlers(statement); end
# Handlers can share state for the entire post processing stage through
@@ -6025,7 +6051,7 @@ class YARD::Handlers::Processor
# @return [OpenStruct] global shared state for post-processing stage
# @see #extra_state
#
- # source://yard//lib/yard/handlers/processor.rb#76
+ # source://yard//lib/yard/handlers/processor.rb#77
def globals; end
# Handlers can share state for the entire post processing stage through
@@ -6045,17 +6071,17 @@ class YARD::Handlers::Processor
# @return [OpenStruct] global shared state for post-processing stage
# @see #extra_state
#
- # source://yard//lib/yard/handlers/processor.rb#76
+ # source://yard//lib/yard/handlers/processor.rb#77
def globals=(_arg0); end
# @return [CodeObjects::NamespaceObject] the current namespace
#
- # source://yard//lib/yard/handlers/processor.rb#43
+ # source://yard//lib/yard/handlers/processor.rb#44
def namespace; end
# @return [CodeObjects::NamespaceObject] the current namespace
#
- # source://yard//lib/yard/handlers/processor.rb#43
+ # source://yard//lib/yard/handlers/processor.rb#44
def namespace=(_arg0); end
# @return [CodeObjects::Base, nil] unlike the namespace, the owner
@@ -6063,7 +6089,7 @@ class YARD::Handlers::Processor
# For instance, when parsing a method body, the {CodeObjects::MethodObject}
# is set as the owner, in case any extra method information is processed.
#
- # source://yard//lib/yard/handlers/processor.rb#55
+ # source://yard//lib/yard/handlers/processor.rb#56
def owner; end
# @return [CodeObjects::Base, nil] unlike the namespace, the owner
@@ -6071,7 +6097,7 @@ class YARD::Handlers::Processor
# For instance, when parsing a method body, the {CodeObjects::MethodObject}
# is set as the owner, in case any extra method information is processed.
#
- # source://yard//lib/yard/handlers/processor.rb#55
+ # source://yard//lib/yard/handlers/processor.rb#56
def owner=(_arg0); end
# Continue parsing the remainder of the files in the +globals.ordered_parser+
@@ -6081,17 +6107,17 @@ class YARD::Handlers::Processor
# @return [void]
# @see Parser::OrderedParser
#
- # source://yard//lib/yard/handlers/processor.rb#139
+ # source://yard//lib/yard/handlers/processor.rb#140
def parse_remaining_files; end
# @return [Symbol] the parser type (:ruby, :ruby18, :c)
#
- # source://yard//lib/yard/handlers/processor.rb#58
+ # source://yard//lib/yard/handlers/processor.rb#59
def parser_type; end
# @return [Symbol] the parser type (:ruby, :ruby18, :c)
#
- # source://yard//lib/yard/handlers/processor.rb#58
+ # source://yard//lib/yard/handlers/processor.rb#59
def parser_type=(_arg0); end
# Processes a list of statements by finding handlers to process each
@@ -6100,27 +6126,27 @@ class YARD::Handlers::Processor
# @param statements [Array] a list of statements
# @return [void]
#
- # source://yard//lib/yard/handlers/processor.rb#109
+ # source://yard//lib/yard/handlers/processor.rb#110
def process(statements); end
# @return [Symbol] the current scope (class, instance)
#
- # source://yard//lib/yard/handlers/processor.rb#49
+ # source://yard//lib/yard/handlers/processor.rb#50
def scope; end
# @return [Symbol] the current scope (class, instance)
#
- # source://yard//lib/yard/handlers/processor.rb#49
+ # source://yard//lib/yard/handlers/processor.rb#50
def scope=(_arg0); end
# @return [Symbol] the current visibility (public, private, protected)
#
- # source://yard//lib/yard/handlers/processor.rb#46
+ # source://yard//lib/yard/handlers/processor.rb#47
def visibility; end
# @return [Symbol] the current visibility (public, private, protected)
#
- # source://yard//lib/yard/handlers/processor.rb#46
+ # source://yard//lib/yard/handlers/processor.rb#47
def visibility=(_arg0); end
private
@@ -6129,7 +6155,7 @@ class YARD::Handlers::Processor
#
# @return [Base] the base class
#
- # source://yard//lib/yard/handlers/processor.rb#171
+ # source://yard//lib/yard/handlers/processor.rb#172
def handler_base_class; end
# The module holding the handlers to be loaded
@@ -6137,12 +6163,12 @@ class YARD::Handlers::Processor
# @return [Module] the module containing the handlers depending on
# {#parser_type}.
#
- # source://yard//lib/yard/handlers/processor.rb#179
+ # source://yard//lib/yard/handlers/processor.rb#180
def handler_base_namespace; end
# @return [Boolean]
#
- # source://yard//lib/yard/handlers/processor.rb#160
+ # source://yard//lib/yard/handlers/processor.rb#161
def handles?(handler, statement); end
# Loads handlers from {#handler_base_namespace}. This ensures that
@@ -6151,7 +6177,7 @@ class YARD::Handlers::Processor
#
# @return [void]
#
- # source://yard//lib/yard/handlers/processor.rb#187
+ # source://yard//lib/yard/handlers/processor.rb#188
def load_handlers; end
class << self
@@ -6171,9 +6197,171 @@ class YARD::Handlers::Processor
end
end
+# Handlers for RBS (Ruby type signature) files.
+#
+# source://yard//lib/yard/autoload.rb#73
+module YARD::Handlers::RBS; end
+
+# Handles RBS attr_reader, attr_writer, and attr_accessor declarations.
+#
+# Registers one or two {YARD::CodeObjects::MethodObject} instances (reader
+# and/or writer) with @return / @param tags derived from the RBS type.
+#
+# source://yard//lib/yard/handlers/rbs/attribute_handler.rb#6
+class YARD::Handlers::RBS::AttributeHandler < ::YARD::Handlers::RBS::Base
+ private
+
+ # source://yard//lib/yard/handlers/rbs/attribute_handler.rb#66
+ def apply_tag_types(obj, tag_name, types, tag_param_name = T.unsafe(nil)); end
+
+ # source://yard//lib/yard/handlers/rbs/attribute_handler.rb#55
+ def register_existing_attribute_method(attr_name, meth_name, type, scope); end
+
+ # source://yard//lib/yard/handlers/rbs/attribute_handler.rb#30
+ def register_reader(name, types, scope); end
+
+ # source://yard//lib/yard/handlers/rbs/attribute_handler.rb#42
+ def register_writer(name, types, scope); end
+end
+
+# Base class for all RBS handlers.
+# Handlers match on the {Parser::RBS::Statement#type} symbol of the
+# current statement and process it to create or annotate code objects.
+#
+# source://yard//lib/yard/handlers/rbs/base.rb#9
+class YARD::Handlers::RBS::Base < ::YARD::Handlers::Base
+ # Recurse into the body of a namespace statement.
+ #
+ # @param opts [Hash] state overrides
+ # @see #push_state
+ #
+ # source://yard//lib/yard/handlers/rbs/base.rb#29
+ def parse_block(opts = T.unsafe(nil)); end
+
+ class << self
+ # @return [Boolean] whether this handler matches the given statement
+ #
+ # source://yard//lib/yard/handlers/rbs/base.rb#11
+ def handles?(statement, _processor); end
+ end
+end
+
+# Handles RBS constant declarations: `Name: Type`
+#
+# source://yard//lib/yard/handlers/rbs/constant_handler.rb#3
+class YARD::Handlers::RBS::ConstantHandler < ::YARD::Handlers::RBS::Base
+ private
+
+ # source://yard//lib/yard/handlers/rbs/constant_handler.rb#15
+ def rbs_types(type_str); end
+end
+
+# Handles RBS method definitions (def name: signature).
+#
+# Creates a {YARD::CodeObjects::MethodObject} for each declaration
+# and infers @param, @return, @yield, and @yieldparam tags from the
+# RBS type signature when those tags are absent from the docstring.
+#
+# source://yard//lib/yard/handlers/rbs/method_handler.rb#7
+class YARD::Handlers::RBS::MethodHandler < ::YARD::Handlers::RBS::Base
+ private
+
+ # Add an @overload tag for one signature overload.
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#86
+ def add_overload_tag(obj, meth_name, sig); end
+
+ # Add @param / @return / @yield / @yieldparam from a single overload sig.
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#66
+ def add_param_return_tags(obj, sig); end
+
+ # Add @yield and @yieldparam tags from a parsed block type.
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#108
+ def add_yield_tags(obj, blk); end
+
+ # Apply tags from all overload signatures to the method object.
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#53
+ def apply_signature_tags(obj, sigs); end
+
+ # Split a type+name string like "Array[String] names" into ["Array[String]", "names"].
+ # The name is the trailing lowercase identifier (if any).
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#213
+ def extract_type_and_name(str); end
+
+ # Find the index of the matching close bracket starting from +start+.
+ #
+ # @return [nil] if no matching bracket is found (malformed input).
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#247
+ def find_matching(str, start, open, close); end
+
+ # Parse the inside of a `{ ... }` block type, e.g. "(Integer) -> String".
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#227
+ def parse_block_type(inner); end
+
+ # Parse a single RBS function type string (one overload) into its components.
+ #
+ # @param sig [String] e.g. "(String name, Integer age) -> String"
+ # @return [Hash] { :params => [...], :block_param => Hash|nil, :return_types => [...] }
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#125
+ def parse_function_type(sig); end
+
+ # Parse a comma-separated parameter list (content inside outer parens).
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#162
+ def parse_params_list(str); end
+
+ # Parse one parameter from an RBS param list.
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#170
+ def parse_single_param(param); end
+
+ # Split +str+ on commas that are not inside brackets.
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#261
+ def split_by_comma(str); end
+
+ class << self
+ # Return the bracket depth of the full string (should be 0 for well-formed types).
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#317
+ def bracket_depth(str); end
+
+ # Convert an RBS type string to an array of YARD type strings.
+ #
+ # @param rbs [String] e.g. "String | Integer", "Array[String]", "bool"
+ # @return [Array]
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#30
+ def rbs_type_to_yard_types(rbs); end
+
+ # Split +str+ on `|` that are not inside brackets.
+ #
+ # source://yard//lib/yard/handlers/rbs/method_handler.rb#289
+ def split_on_pipe(str); end
+ end
+end
+
+# Handles RBS include, extend, and prepend declarations.
+#
+# source://yard//lib/yard/handlers/rbs/mixin_handler.rb#3
+class YARD::Handlers::RBS::MixinHandler < ::YARD::Handlers::RBS::Base; end
+
+# Handles RBS class, module, and interface declarations by registering
+# the corresponding namespace code objects and recursing into their bodies.
+#
+# source://yard//lib/yard/handlers/rbs/namespace_handler.rb#4
+class YARD::Handlers::RBS::NamespaceHandler < ::YARD::Handlers::RBS::Base; end
+
# All Ruby handlers
#
-# source://yard//lib/yard/autoload.rb#92
+# source://yard//lib/yard/autoload.rb#102
module YARD::Handlers::Ruby; end
# Handles alias and alias_method calls
@@ -6194,7 +6382,7 @@ class YARD::Handlers::Ruby::AttributeHandler < ::YARD::Handlers::Ruby::Base
# @raise [Parser::UndocumentableError] if the arguments are not valid.
# @return [Array] the validated attribute names
#
- # source://yard//lib/yard/handlers/ruby/attribute_handler.rb#75
+ # source://yard//lib/yard/handlers/ruby/attribute_handler.rb#78
def validated_attribute_names(params); end
end
@@ -6346,19 +6534,22 @@ class YARD::Handlers::Ruby::ConstantHandler < ::YARD::Handlers::Ruby::Base
private
- # Extract the parameters from the Struct.new AST node, returning them as a list
+ # Extract the parameters from the Struct.new or Data.define AST node, returning them as a list
# of strings
#
- # @param superclass [MethodCallNode] the AST node for the Struct.new call
+ # @param superclass [MethodCallNode] the AST node for the Struct.new or Data.define call
# @return [Array] the member names to generate methods for
#
- # source://yard//lib/yard/handlers/ruby/constant_handler.rb#49
+ # source://yard//lib/yard/handlers/ruby/constant_handler.rb#67
def extract_parameters(superclass); end
- # source://yard//lib/yard/handlers/ruby/constant_handler.rb#21
+ # source://yard//lib/yard/handlers/ruby/constant_handler.rb#24
def process_constant(statement); end
- # source://yard//lib/yard/handlers/ruby/constant_handler.rb#33
+ # source://yard//lib/yard/handlers/ruby/constant_handler.rb#47
+ def process_dataclass(statement); end
+
+ # source://yard//lib/yard/handlers/ruby/constant_handler.rb#36
def process_structclass(statement); end
end
@@ -6487,7 +6678,7 @@ end
# Handlers for old Ruby 1.8 parser
#
-# source://yard//lib/yard/autoload.rb#93
+# source://yard//lib/yard/autoload.rb#103
module YARD::Handlers::Ruby::Legacy; end
# Handles alias and alias_method calls
@@ -6867,7 +7058,7 @@ class YARD::Handlers::Ruby::PublicClassMethodHandler < ::YARD::Handlers::Ruby::B
include ::YARD::Handlers::Ruby::DecoratorHandlerMethods
end
-# Helper methods to parse @attr_* tags on a class.
+# Helper methods to document generated Struct and Data members.
#
# @deprecated The use of +@attr+ tags are deprecated since 0.8.0 in favour of
# the +@!attribute+ directive. This module should not be relied on.
@@ -6886,7 +7077,7 @@ module YARD::Handlers::Ruby::StructHandlerMethods
# @return [String] a docstring to be attached to the getter method for this member
# @since 0.5.6
#
- # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#62
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#82
def add_reader_tags(klass, new_method, member); end
# Creates the auto-generated docstring for the setter method of a struct's
@@ -6898,7 +7089,7 @@ module YARD::Handlers::Ruby::StructHandlerMethods
# @return [String] a docstring to be attached to the setter method for this member
# @since 0.5.6
#
- # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#77
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#97
def add_writer_tags(klass, new_method, member); end
# Creates the given member methods and attaches them to the given ClassObject.
@@ -6907,7 +7098,7 @@ module YARD::Handlers::Ruby::StructHandlerMethods
# @param members [Array] a list of member names
# @since 0.5.6
#
- # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#134
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#154
def create_attributes(klass, members); end
# Creates and registers a class object with the given name and superclass name.
@@ -6918,7 +7109,7 @@ module YARD::Handlers::Ruby::StructHandlerMethods
# @return [ClassObject] the class object for further processing/method attaching
# @since 0.5.6
#
- # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#92
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#112
def create_class(classname, superclass); end
# Determines whether to create an attribute method based on the class's
@@ -6930,7 +7121,7 @@ module YARD::Handlers::Ruby::StructHandlerMethods
# @return [Boolean] should the attribute be created?
# @since 0.5.6
#
- # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#38
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#58
def create_member_method?(klass, member, type = T.unsafe(nil)); end
# Creates the getter (reader) method and attaches it to the class as an attribute.
@@ -6940,7 +7131,7 @@ module YARD::Handlers::Ruby::StructHandlerMethods
# @param member [String] the name of the member we're generating a method for
# @since 0.5.6
#
- # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#121
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#141
def create_reader(klass, member); end
# Creates the setter (writer) method and attaches it to the class as an attribute.
@@ -6950,7 +7141,7 @@ module YARD::Handlers::Ruby::StructHandlerMethods
# @param member [String] the name of the member we're generating a method for
# @since 0.5.6
#
- # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#104
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#124
def create_writer(klass, member); end
# Extracts the user's defined @member tag for a given class and its member. Returns
@@ -6971,9 +7162,33 @@ module YARD::Handlers::Ruby::StructHandlerMethods
# @return [Array] the list of members defined as attributes on the class
# @since 0.5.6
#
- # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#26
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#46
def members_from_tags(klass); end
+ # Extracts the user's defined @param tag for a given generated member.
+ #
+ # @param klass [ClassObject] the class whose tags we're searching
+ # @param member [String] the name of the struct or data member we need
+ # @return [Tags::Tag, nil] the matching tag, or nil if not found
+ # @since 0.5.6
+ #
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#27
+ def parameter_tag_for_member(klass, member); end
+
+ # @since 0.5.6
+ #
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#175
+ def register_docstring(object, docstring = T.unsafe(nil), stmt = T.unsafe(nil)); end
+
+ # Registers an auto-generated member method without reapplying the class's
+ # docstring to it. The generated reader or writer receives its own docstring
+ # and tags immediately after registration.
+ #
+ # @since 0.5.6
+ #
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#167
+ def register_struct_member_method(method, &block); end
+
# Gets the return type for the member in a nicely formatted string. Used
# to be injected into auto-generated docstrings.
#
@@ -6982,8 +7197,20 @@ module YARD::Handlers::Ruby::StructHandlerMethods
# the user did not define a type for this member.
# @since 0.5.6
#
- # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#51
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#71
def return_type_from_tag(member_tag); end
+
+ # Returns the tag that supplies a generated member's type. Existing @attr*
+ # tags take precedence over the more concise @param form.
+ #
+ # @param klass [ClassObject] the class whose tags we're searching
+ # @param member [String] the name of the struct or data member we need
+ # @param type [Symbol] reader method, or writer method?
+ # @return [Tags::Tag, nil] the tag supplying the type, or nil if not found
+ # @since 0.5.6
+ #
+ # source://yard//lib/yard/handlers/ruby/struct_handler_methods.rb#38
+ def type_tag_for_member(klass, member, type = T.unsafe(nil)); end
end
# source://yard//lib/yard/handlers/ruby/base.rb#53
@@ -7002,7 +7229,7 @@ class YARD::Handlers::Ruby::VisibilityHandler < ::YARD::Handlers::Ruby::Base
# @return [Boolean]
#
- # source://yard//lib/yard/handlers/ruby/visibility_handler.rb#31
+ # source://yard//lib/yard/handlers/ruby/visibility_handler.rb#32
def is_attribute_method?(node); end
end
@@ -7015,7 +7242,7 @@ class YARD::Handlers::Ruby::YieldHandler < ::YARD::Handlers::Ruby::Base; end
#
# @since 0.8.0
#
-# source://yard//lib/yard/autoload.rb#151
+# source://yard//lib/yard/autoload.rb#161
module YARD::I18n; end
# +Locale+ is a unit of translation. It has {#name} and a set of
@@ -7046,7 +7273,7 @@ class YARD::I18n::Locale
# @return [String] the name of the locale. It used IETF language
# tag format +[language[_territory][.codeset][@modifier]]+.
- # @see http://tools.ietf.org/rfc/bcp/bcp47.txt BCP 47 - Tags for Identifying Languages
+ # @see https://tools.ietf.org/rfc/bcp/bcp47.txt BCP 47 - Tags for Identifying Languages
# @since 0.8.2
#
# source://yard//lib/yard/i18n/locale.rb#29
@@ -7258,7 +7485,7 @@ end
# File.open(po_file_path, "w") do |pot_file|
# pot_file.print(pot)
# end
-# @see http://www.gnu.org/software/gettext/manual/html_node/PO-Files.html GNU gettext manual about details of PO file
+# @see https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html GNU gettext manual about details of PO file
# @since 0.8.0
#
# source://yard//lib/yard/i18n/pot_generator.rb#65
@@ -7994,7 +8221,7 @@ end
# The parser namespace holds all parsing engines used by YARD.
# Currently only Ruby and C (Ruby) parsers are implemented.
#
-# source://yard//lib/yard/autoload.rb#161
+# source://yard//lib/yard/autoload.rb#171
module YARD::Parser; end
# Represents the abstract base parser class that parses source code in
@@ -8069,7 +8296,7 @@ end
# CRuby Parsing components
#
-# source://yard//lib/yard/autoload.rb#162
+# source://yard//lib/yard/autoload.rb#172
module YARD::Parser::C; end
# source://yard//lib/yard/parser/c/statement.rb#41
@@ -8400,9 +8627,170 @@ end
# source://yard//lib/yard/parser/source_parser.rb#12
class YARD::Parser::ParserSyntaxError < ::YARD::Parser::UndocumentableError; end
+# RBS type signature parser
+#
+# source://yard//lib/yard/autoload.rb#197
+module YARD::Parser::RBS; end
+
+# Parses RBS (Ruby type signature) files and produces a list of
+# {Statement} objects for post-processing by handlers.
+#
+# RBS is Ruby's official type signature format (introduced in Ruby 3.0).
+# This parser handles: class/module/interface declarations, method
+# signatures, attribute accessors, mixins, and constants.
+#
+# No external gem dependencies are used; the parser is hand-written.
+#
+# source://yard//lib/yard/parser/rbs/rbs_parser.rb#13
+class YARD::Parser::RBS::RbsParser < ::YARD::Parser::Base
+ # @param source [String] source code to parse
+ # @param filename [String] path to the source file
+ # @return [RbsParser] a new instance of RbsParser
+ #
+ # source://yard//lib/yard/parser/rbs/rbs_parser.rb#16
+ def initialize(source, filename); end
+
+ # @return [Array] top-level statements for the post-processor
+ #
+ # source://yard//lib/yard/parser/rbs/rbs_parser.rb#36
+ def enumerator; end
+
+ # Parses the source and returns self.
+ #
+ # @return [RbsParser] self
+ #
+ # source://yard//lib/yard/parser/rbs/rbs_parser.rb#24
+ def parse; end
+
+ # Tokenization is not implemented for RBS.
+ #
+ # @raise [NotImplementedError]
+ #
+ # source://yard//lib/yard/parser/rbs/rbs_parser.rb#31
+ def tokenize; end
+
+ private
+
+ # source://yard//lib/yard/parser/rbs/rbs_parser.rb#296
+ def parse_attr(type, lines, i, docs, crange); end
+
+ # Parse a sequence of lines, returning statements and the index after the last consumed line.
+ #
+ # @param lines [Array] source lines
+ # @param start [Integer] index to start from (0-based)
+ # @param stop_at_end [Boolean] when true, stop parsing when we see a bare `end`
+ # @return [Array(Array, Integer)] [statements, new_index]
+ #
+ # source://yard//lib/yard/parser/rbs/rbs_parser.rb#48
+ def parse_body(lines, start, stop_at_end); end
+
+ # source://yard//lib/yard/parser/rbs/rbs_parser.rb#253
+ def parse_method_def(sanitized, lines, i, docs, crange); end
+
+ # source://yard//lib/yard/parser/rbs/rbs_parser.rb#199
+ def parse_namespace(type, lines, i, docs, crange); end
+
+ # Dispatch a single declaration line.
+ #
+ # source://yard//lib/yard/parser/rbs/rbs_parser.rb#125
+ def parse_statement(lines, i, comments, comment_start_1); end
+
+ # source://yard//lib/yard/parser/rbs/rbs_parser.rb#112
+ def sanitized_statement_lines(lines, start_index); end
+
+ # source://yard//lib/yard/parser/rbs/rbs_parser.rb#86
+ def strip_inline_comment(line); end
+end
+
+# Represents a single parsed declaration from an RBS file.
+# Each Statement may have a block of child statements for
+# namespace declarations (class, module, interface).
+#
+# source://yard//lib/yard/parser/rbs/statement.rb#8
+class YARD::Parser::RBS::Statement
+ # @return [Statement] a new instance of Statement
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#52
+ def initialize(attrs = T.unsafe(nil)); end
+
+ # @return [String, nil] RBS type annotation for attrs and constants
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#47
+ def attr_rbs_type; end
+
+ # @return [Array] child statements for namespace blocks
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#37
+ def block; end
+
+ # @return [String, nil] adjacent comment text (the docstring)
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#28
+ def comments; end
+
+ # @return [false] RBS files don't use ## hash-flag comments
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#34
+ def comments_hash_flag; end
+
+ # @return [Range, nil] line range of the preceding comments
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#31
+ def comments_range; end
+
+ # @return [Integer] 1-indexed line number of this statement
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#22
+ def line; end
+
+ # @return [String, nil] mixin name for :include/:extend/:prepend
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#44
+ def mixin_name; end
+
+ # @return [String] the declaration name
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#16
+ def name; end
+
+ # @return [String] a textual snippet used in error messages
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#69
+ def show; end
+
+ # @return [Array] RBS type signature strings for :method_def
+ # Each element is one overload (e.g. "(String name) -> Integer")
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#41
+ def signatures; end
+
+ # @return [String] raw source text of the statement
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#25
+ def source; end
+
+ # @return [String, nil] the superclass name (for :class)
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#19
+ def superclass; end
+
+ # @return [Symbol] declaration type:
+ # :class, :module, :interface, :method_def,
+ # :attr_reader, :attr_writer, :attr_accessor,
+ # :include, :extend, :prepend, :constant, :alias
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#13
+ def type; end
+
+ # @return [Symbol, nil] :class or :instance scope hint from parser
+ #
+ # source://yard//lib/yard/parser/rbs/statement.rb#50
+ def visibility; end
+end
+
# Ruby parsing components.
#
-# source://yard//lib/yard/autoload.rb#171
+# source://yard//lib/yard/autoload.rb#181
module YARD::Parser::Ruby
# Builds and s-expression by creating {AstNode} objects with
# the type provided by the first argument.
@@ -8751,59 +9139,59 @@ end
# source://yard//lib/yard/parser/ruby/ast_node.rb#96
YARD::Parser::Ruby::AstNode::KEYWORDS = T.let(T.unsafe(nil), Hash)
-# source://yard//lib/yard/parser/ruby/ast_node.rb#530
+# source://yard//lib/yard/parser/ruby/ast_node.rb#531
class YARD::Parser::Ruby::ClassNode < ::YARD::Parser::Ruby::KeywordNode
- # source://yard//lib/yard/parser/ruby/ast_node.rb#533
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#534
def block; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#531
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#532
def class_name; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#532
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#533
def superclass; end
end
# Represents a lone comment block in source
#
-# source://yard//lib/yard/parser/ruby/ast_node.rb#548
+# source://yard//lib/yard/parser/ruby/ast_node.rb#549
class YARD::Parser::Ruby::CommentNode < ::YARD::Parser::Ruby::AstNode
- # source://yard//lib/yard/parser/ruby/ast_node.rb#549
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#550
def comments; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#549
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#550
def docstring; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#550
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#551
def docstring=(value); end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#554
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#555
def first_line; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#553
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#554
def source; end
end
-# source://yard//lib/yard/parser/ruby/ast_node.rb#515
+# source://yard//lib/yard/parser/ruby/ast_node.rb#516
class YARD::Parser::Ruby::ConditionalNode < ::YARD::Parser::Ruby::KeywordNode
- # source://yard//lib/yard/parser/ruby/ast_node.rb#517
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#518
def condition; end
# @return [Boolean]
#
- # source://yard//lib/yard/parser/ruby/ast_node.rb#516
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#517
def condition?; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#520
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#521
def else_block; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#518
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#519
def then_block; end
private
# @return [Boolean]
#
- # source://yard//lib/yard/parser/ruby/ast_node.rb#527
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#528
def cmod?; end
end
@@ -8817,7 +9205,7 @@ end
# Handles Ruby parsing in Ruby 1.8.
#
-# source://yard//lib/yard/autoload.rb#172
+# source://yard//lib/yard/autoload.rb#182
module YARD::Parser::Ruby::Legacy; end
# Lexical analyzer for Ruby source
@@ -9141,102 +9529,15 @@ YARD::Parser::Ruby::Legacy::RubyToken::EXPR_MID = T.let(T.unsafe(nil), Symbol)
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#308
YARD::Parser::Ruby::Legacy::RubyToken::NEWLINE_TOKEN = T.let(T.unsafe(nil), YARD::Parser::Ruby::Legacy::RubyToken::TkNL)
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::OPASGN < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkALIAS < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkAMPER < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkAND < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkANDOP < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkAREF < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkASET < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkASSIGN < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkASSOC < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkAT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkUnknownChar; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkBACKQUOTE < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkBACKSLASH < ::YARD::Parser::Ruby::Legacy::RubyToken::TkUnknownChar; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkBACK_REF < ::YARD::Parser::Ruby::Legacy::RubyToken::TkId; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkBEGIN < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkBITAND < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkBITNOT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkBITOR < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkBITXOR < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkBREAK < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
+class YARD::Parser::Ruby::Legacy::RubyToken::TkBREAK < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
# Represents a block
#
@@ -9246,171 +9547,38 @@ class YARD::Parser::Ruby::Legacy::RubyToken::TkBlockContents < ::YARD::Parser::R
def text; end
end
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkCASE < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkCLASS < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkCMP < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkCOLON < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkCOLON2 < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkCOLON3 < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkCOMMA < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkCOMMENT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkVal; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkCONSTANT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkId; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkDEF < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkDEFINED < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkDIV < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkDO < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkDOLLAR < ::YARD::Parser::Ruby::Legacy::RubyToken::TkUnknownChar; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkDOT < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkDOT2 < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkDOT3 < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkDREGEXP < ::YARD::Parser::Ruby::Legacy::RubyToken::TkNode; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkDSTRING < ::YARD::Parser::Ruby::Legacy::RubyToken::TkNode; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkDXSTRING < ::YARD::Parser::Ruby::Legacy::RubyToken::TkNode; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkELSE < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkELSIF < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkEND < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkEND_OF_SCRIPT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkWhitespace; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkENSURE < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkEQ < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkEQQ < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#115
class YARD::Parser::Ruby::Legacy::RubyToken::TkError < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkFALSE < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkFID < ::YARD::Parser::Ruby::Legacy::RubyToken::TkId; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkFLOAT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkVal; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkFOR < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkGEQ < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkGT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkGVAR < ::YARD::Parser::Ruby::Legacy::RubyToken::TkId; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkIDENTIFIER < ::YARD::Parser::Ruby::Legacy::RubyToken::TkId; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkIF < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkIF_MOD < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkIN < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkINTEGER < ::YARD::Parser::Ruby::Legacy::RubyToken::TkVal; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkIVAR < ::YARD::Parser::Ruby::Legacy::RubyToken::TkId; end
# Represents a Ruby identifier
@@ -9433,104 +9601,15 @@ end
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#81
class YARD::Parser::Ruby::Legacy::RubyToken::TkKW < ::YARD::Parser::Ruby::Legacy::RubyToken::TkId; end
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkLABEL < ::YARD::Parser::Ruby::Legacy::RubyToken::TkVal; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkLBRACE < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkLBRACK < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkLEQ < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkLPAREN < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkLSHFT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkLT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkMATCH < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkMINUS < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkMOD < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkMODULE < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkMULT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkNEQ < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkNEXT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkNIL < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkNL < ::YARD::Parser::Ruby::Legacy::RubyToken::TkWhitespace; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkNMATCH < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkNOT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkNOTOP < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkNTH_REF < ::YARD::Parser::Ruby::Legacy::RubyToken::TkId; end
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#63
@@ -9554,102 +9633,36 @@ class YARD::Parser::Ruby::Legacy::RubyToken::TkOPASGN < ::YARD::Parser::Ruby::Le
def op; end
end
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkOR < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkOROP < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#92
class YARD::Parser::Ruby::Legacy::RubyToken::TkOp < ::YARD::Parser::Ruby::Legacy::RubyToken::Token
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#93
def name; end
end
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkPLUS < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkPOW < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkQUESTION < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkRBRACE < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkRBRACK < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkREDO < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkREGEXP < ::YARD::Parser::Ruby::Legacy::RubyToken::TkVal; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkRESCUE < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkRETRY < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkRETURN < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkRPAREN < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkRSHFT < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
# { reading => token_class }
# { reading => [token_class, *opt] }
#
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#271
YARD::Parser::Ruby::Legacy::RubyToken::TkReading2Token = T.let(T.unsafe(nil), Hash)
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkSELF < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkSEMICOLON < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkSPACE < ::YARD::Parser::Ruby::Legacy::RubyToken::TkWhitespace; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkSTAR < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkSTRING < ::YARD::Parser::Ruby::Legacy::RubyToken::TkVal; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkSUPER < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkSYMBEG < ::YARD::Parser::Ruby::Legacy::RubyToken::TkId; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkSYMBOL < ::YARD::Parser::Ruby::Legacy::RubyToken::TkVal; end
# Represents an end statement
@@ -9663,41 +9676,14 @@ end
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#272
YARD::Parser::Ruby::Legacy::RubyToken::TkSymbol2Token = T.let(T.unsafe(nil), Hash)
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkTHEN < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkTRUE < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkUMINUS < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkUNDEF < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkUNLESS < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkUNLESS_MOD < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkUNTIL < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkUNTIL_MOD < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
-class YARD::Parser::Ruby::Legacy::RubyToken::TkUPLUS < ::YARD::Parser::Ruby::Legacy::RubyToken::TkOp
- class << self
- def op_name; end
- end
-end
-
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#107
class YARD::Parser::Ruby::Legacy::RubyToken::TkUnknownChar < ::YARD::Parser::Ruby::Legacy::RubyToken::Token
# @return [TkUnknownChar] a new instance of TkUnknownChar
@@ -9721,13 +9707,8 @@ class YARD::Parser::Ruby::Legacy::RubyToken::TkVal < ::YARD::Parser::Ruby::Legac
def initialize(line_no, char_no, value = T.unsafe(nil)); end
end
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkWHEN < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkWHILE < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkWHILE_MOD < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
# Represents whitespace
@@ -9735,22 +9716,11 @@ class YARD::Parser::Ruby::Legacy::RubyToken::TkWHILE_MOD < ::YARD::Parser::Ruby:
# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#68
class YARD::Parser::Ruby::Legacy::RubyToken::TkWhitespace < ::YARD::Parser::Ruby::Legacy::RubyToken::Token; end
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkXSTRING < ::YARD::Parser::Ruby::Legacy::RubyToken::TkVal; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TkYIELD < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::Tk__FILE__ < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::Tk__LINE__ < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TklBEGIN < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
-
-# source://yard//lib/yard/parser/ruby/legacy/ruby_lex.rb#281
class YARD::Parser::Ruby::Legacy::RubyToken::TklEND < ::YARD::Parser::Ruby::Legacy::RubyToken::TkKW; end
# Represents a token in the Ruby lexer
@@ -10081,91 +10051,91 @@ class YARD::Parser::Ruby::LiteralNode < ::YARD::Parser::Ruby::AstNode
def literal?; end
end
-# source://yard//lib/yard/parser/ruby/ast_node.rb#541
+# source://yard//lib/yard/parser/ruby/ast_node.rb#542
class YARD::Parser::Ruby::LoopNode < ::YARD::Parser::Ruby::KeywordNode
- # source://yard//lib/yard/parser/ruby/ast_node.rb#544
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#545
def block; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#543
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#544
def condition; end
# @return [Boolean]
#
- # source://yard//lib/yard/parser/ruby/ast_node.rb#542
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#543
def loop?; end
end
-# source://yard//lib/yard/parser/ruby/ast_node.rb#438
+# source://yard//lib/yard/parser/ruby/ast_node.rb#439
class YARD::Parser::Ruby::MethodCallNode < ::YARD::Parser::Ruby::AstNode
- # source://yard//lib/yard/parser/ruby/ast_node.rb#464
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#465
def block; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#462
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#463
def block_param; end
# @return [Boolean]
#
- # source://yard//lib/yard/parser/ruby/ast_node.rb#439
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#440
def call?; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#442
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#443
def method_name(name_only = T.unsafe(nil)); end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#440
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#441
def namespace; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#453
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#454
def parameters(include_block_param = T.unsafe(nil)); end
private
# @return [Boolean]
#
- # source://yard//lib/yard/parser/ruby/ast_node.rb#474
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#475
def call_has_paren?; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#470
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#471
def index_adjust; end
end
-# source://yard//lib/yard/parser/ruby/ast_node.rb#479
+# source://yard//lib/yard/parser/ruby/ast_node.rb#480
class YARD::Parser::Ruby::MethodDefinitionNode < ::YARD::Parser::Ruby::AstNode
def block(n = T.unsafe(nil)); end
# @return [Boolean]
#
- # source://yard//lib/yard/parser/ruby/ast_node.rb#481
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#482
def def?; end
# @return [Boolean]
#
- # source://yard//lib/yard/parser/ruby/ast_node.rb#480
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#481
def kw?; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#484
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#485
def method_name(name_only = T.unsafe(nil)); end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#482
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#483
def namespace; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#489
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#490
def parameters(include_block_param = T.unsafe(nil)); end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#495
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#496
def signature; end
private
- # source://yard//lib/yard/parser/ruby/ast_node.rb#510
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#511
def index_adjust; end
end
-# source://yard//lib/yard/parser/ruby/ast_node.rb#536
+# source://yard//lib/yard/parser/ruby/ast_node.rb#537
class YARD::Parser::Ruby::ModuleNode < ::YARD::Parser::Ruby::KeywordNode
- # source://yard//lib/yard/parser/ruby/ast_node.rb#538
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#539
def block; end
- # source://yard//lib/yard/parser/ruby/ast_node.rb#537
+ # source://yard//lib/yard/parser/ruby/ast_node.rb#538
def module_name; end
end
@@ -10301,9 +10271,6 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#155
def on_args_new(*args); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#177
- def on_aryptn(*args); end
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#177
def on_assign(*args); end
@@ -10418,9 +10385,6 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#188
def on_float(tok); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#177
- def on_fndptn(*args); end
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#170
def on_for(*args); end
@@ -10436,16 +10400,13 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#188
def on_heredoc_end(tok); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#177
- def on_hshptn(*args); end
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#188
def on_ident(tok); end
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#170
def on_if(*args); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#449
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#512
def on_if_mod(*args); end
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#177
@@ -10553,30 +10514,27 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#188
def on_period(tok); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#474
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#537
def on_qsymbols_add(list, item); end
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#199
def on_qsymbols_beg(tok); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#462
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#525
def on_qsymbols_new(*args); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#474
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#537
def on_qwords_add(list, item); end
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#199
def on_qwords_beg(tok); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#462
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#525
def on_qwords_new(*args); end
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#188
def on_rational(tok); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#188
- def on_rbrace(tok); end
-
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#170
def on_redo(*args); end
@@ -10649,13 +10607,13 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#177
def on_symbol_literal(*args); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#474
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#537
def on_symbols_add(list, item); end
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#199
def on_symbols_beg(tok); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#462
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#525
def on_symbols_new(*args); end
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#199
@@ -10682,13 +10640,13 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#170
def on_unless(*args); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#449
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#512
def on_unless_mod(*args); end
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#170
def on_until(*args); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#449
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#512
def on_until_mod(*args); end
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#177
@@ -10709,7 +10667,7 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#170
def on_while(*args); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#449
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#512
def on_while_mod(*args); end
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#162
@@ -10718,13 +10676,13 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#155
def on_word_new(*args); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#474
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#537
def on_words_add(list, item); end
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#199
def on_words_beg(tok); end
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#462
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#525
def on_words_new(*args); end
# source://yard//lib/yard/parser/ruby/ruby_parser.rb#188
@@ -10772,150 +10730,173 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#667
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#750
def add_comment(line, node = T.unsafe(nil), before_node = T.unsafe(nil), into = T.unsafe(nil)); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#271
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#286
def add_token(token, data); end
# @return [Boolean]
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#611
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#674
def comment_starts_line?(charno); end
# @raise [ParserSyntaxError]
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#606
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#669
def compile_error(msg); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#693
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#781
def freeze_tree(node = T.unsafe(nil)); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#620
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#684
def insert_comments; end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#377
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#408
def on_aref(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#385
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#416
def on_aref_field(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#391
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#424
def on_array(other); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#352
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#448
+ def on_aryptn(*args); end
+
+ # @since 0.5.6
+ #
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#368
def on_assoc_new(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#364
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#395
def on_assoclist_from_args(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#360
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#391
def on_bare_assoc_hash(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#347
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#363
def on_body_stmt(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#347
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#363
def on_bodystmt(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#542
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#605
def on_comment(comment); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#441
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#504
def on_const_path_ref(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#419
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#482
def on_dyna_symbol(sym); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#592
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#655
def on_embdoc(text); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#586
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#649
def on_embdoc_beg(text); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#597
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#660
def on_embdoc_end(text); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#356
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#457
+ def on_fndptn(*args); end
+
+ # @since 0.5.6
+ #
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#372
def on_hash(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#534
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#383
+ def on_hshptn(*args); end
+
+ # @since 0.5.6
+ #
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#597
def on_label(data); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#497
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#560
def on_lambda(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#409
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#465
def on_lbracket(tok); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#515
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#578
def on_params(*args); end
# @raise [ParserSyntaxError]
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#606
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#669
def on_parse_error(msg); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#343
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#359
def on_program(*args); end
+ # Maintained explicitly (unlike on_lbracket/on_rbracket) so on_hshptn can
+ # distinguish braced from bare hash patterns in Ruby 3.0+ pattern matching.
+ #
+ # @since 0.5.6
+ #
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#477
+ def on_rbrace(tok); end
+
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#414
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#470
def on_rbracket(tok); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#506
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#569
def on_rescue(exc, *args); end
# @since 0.5.6
@@ -10925,27 +10906,27 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#501
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#564
def on_string_content(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#484
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#547
def on_string_literal(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#429
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#492
def on_top_const_ref(*args); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#368
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#399
def on_unary(op, val); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#511
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#574
def on_void_stmt; end
# @since 0.5.6
@@ -10955,12 +10936,12 @@ class YARD::Parser::Ruby::RipperParser < ::Ripper
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#251
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#263
def visit_event_arr(node); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/ruby/ruby_parser.rb#259
+ # source://yard//lib/yard/parser/ruby/ruby_parser.rb#271
def visit_ns_token(token, data, ast_token = T.unsafe(nil)); end
end
@@ -11131,30 +11112,30 @@ class YARD::Parser::SourceParser
# @overload initialize
# @return [SourceParser] a new instance of SourceParser
#
- # source://yard//lib/yard/parser/source_parser.rb#406
+ # source://yard//lib/yard/parser/source_parser.rb#407
def initialize(parser_type = T.unsafe(nil), globals1 = T.unsafe(nil), globals2 = T.unsafe(nil)); end
# @return [String] the contents of the file to be parsed
# @since 0.7.0
#
- # source://yard//lib/yard/parser/source_parser.rb#399
+ # source://yard//lib/yard/parser/source_parser.rb#400
def contents; end
# @return [String] the filename being parsed by the parser.
#
- # source://yard//lib/yard/parser/source_parser.rb#386
+ # source://yard//lib/yard/parser/source_parser.rb#387
def file; end
# @return [String] the filename being parsed by the parser.
#
- # source://yard//lib/yard/parser/source_parser.rb#386
+ # source://yard//lib/yard/parser/source_parser.rb#387
def file=(_arg0); end
# @return [OpenStruct] an open struct containing arbitrary global state
# shared between files and handlers.
# @since 0.7.0
#
- # source://yard//lib/yard/parser/source_parser.rb#395
+ # source://yard//lib/yard/parser/source_parser.rb#396
def globals; end
# The main parser method. This should not be called directly. Instead,
@@ -11163,13 +11144,13 @@ class YARD::Parser::SourceParser
# @param content [String, #read, Object] the source file to parse
# @return [Object, nil] the parser object used to parse the source
#
- # source://yard//lib/yard/parser/source_parser.rb#418
+ # source://yard//lib/yard/parser/source_parser.rb#419
def parse(content = T.unsafe(nil)); end
# @return [Symbol] the parser type associated with the parser instance.
# This should be set by the {#initialize constructor}.
#
- # source://yard//lib/yard/parser/source_parser.rb#390
+ # source://yard//lib/yard/parser/source_parser.rb#391
def parser_type; end
# Tokenizes but does not parse the block of code using the current {#parser_type}
@@ -11177,7 +11158,7 @@ class YARD::Parser::SourceParser
# @param content [String] the block of code to tokenize
# @return [Array] a list of tokens
#
- # source://yard//lib/yard/parser/source_parser.rb#462
+ # source://yard//lib/yard/parser/source_parser.rb#463
def tokenize(content); end
private
@@ -11186,15 +11167,15 @@ class YARD::Parser::SourceParser
#
# @since 0.5.3
#
- # source://yard//lib/yard/parser/source_parser.rb#471
+ # source://yard//lib/yard/parser/source_parser.rb#472
def convert_encoding(content); end
# @since 0.5.6
#
- # source://yard//lib/yard/parser/source_parser.rb#515
+ # source://yard//lib/yard/parser/source_parser.rb#516
def parser_class; end
- # source://yard//lib/yard/parser/source_parser.rb#500
+ # source://yard//lib/yard/parser/source_parser.rb#501
def parser_type=(value); end
# Guesses the parser type to use depending on the file extension.
@@ -11202,14 +11183,14 @@ class YARD::Parser::SourceParser
# @param filename [String] the filename to use to guess the parser type
# @return [Symbol] a parser type that matches the filename
#
- # source://yard//lib/yard/parser/source_parser.rb#508
+ # source://yard//lib/yard/parser/source_parser.rb#509
def parser_type_for_filename(filename); end
# Runs a {Handlers::Processor} object to post process the parsed statements.
#
# @return [void]
#
- # source://yard//lib/yard/parser/source_parser.rb#490
+ # source://yard//lib/yard/parser/source_parser.rb#491
def post_process; end
class << self
@@ -11513,7 +11494,7 @@ YARD::ROOT = T.let(T.unsafe(nil), String)
# Holds Rake tasks used by YARD
#
-# source://yard//lib/yard/autoload.rb#192
+# source://yard//lib/yard/autoload.rb#208
module YARD::Rake; end
# The rake task to run {CLI::Yardoc} and generate documentation.
@@ -12079,48 +12060,48 @@ class YARD::RegistryResolver
#
# @since 0.9.1
#
- # source://yard//lib/yard/registry_resolver.rb#181
+ # source://yard//lib/yard/registry_resolver.rb#188
def collect_namespaces(object); end
# Performs a lexical lookup from a namespace for a path and a type hint.
#
# @since 0.9.1
#
- # source://yard//lib/yard/registry_resolver.rb#104
+ # source://yard//lib/yard/registry_resolver.rb#111
def lookup_path_direct(namespace, path, type); end
# Performs a lookup through the inheritance chain on a path with a type hint.
#
# @since 0.9.1
#
- # source://yard//lib/yard/registry_resolver.rb#121
+ # source://yard//lib/yard/registry_resolver.rb#128
def lookup_path_inherited(namespace, path, type); end
# @return [Regexp] the regexp that can be used to split a string on all
# occurrences of separator tokens
# @since 0.9.1
#
- # source://yard//lib/yard/registry_resolver.rb#206
+ # source://yard//lib/yard/registry_resolver.rb#213
def split_on_separators_match; end
# @return [Regexp] the regexp match of the default separator
# @since 0.9.1
#
- # source://yard//lib/yard/registry_resolver.rb#194
+ # source://yard//lib/yard/registry_resolver.rb#201
def starts_with_default_separator_match; end
# @return [Regexp] the regexp that matches strings starting with
# a separator
# @since 0.9.1
#
- # source://yard//lib/yard/registry_resolver.rb#200
+ # source://yard//lib/yard/registry_resolver.rb#207
def starts_with_separator_match; end
# return [Boolean] if the obj's type matches the provided type.
#
# @since 0.9.1
#
- # source://yard//lib/yard/registry_resolver.rb#99
+ # source://yard//lib/yard/registry_resolver.rb#106
def validate(obj, type); end
end
@@ -12365,7 +12346,7 @@ end
# Namespace for components that serialize to various endpoints
#
-# source://yard//lib/yard/autoload.rb#196
+# source://yard//lib/yard/autoload.rb#212
module YARD::Serializers; end
# The abstract base serializer. Serializers allow templates to be
@@ -12666,16 +12647,26 @@ end
#
# @since 0.6.0
#
-# source://yard//lib/yard/autoload.rb#214
+# source://yard//lib/yard/autoload.rb#230
module YARD::Server
class << self
+ # Normalizes an HTTP request path into a relative command path.
+ #
+ # @api private
+ # @param path [String] the request path to normalize
+ # @return [String] a relative path using forward slashes
+ # @since 0.6.0
+ #
+ # source://yard//lib/yard/server.rb#8
+ def clean_path(path); end
+
# Registers a static path to be used in static asset lookup.
#
# @param path [String] the pathname to register
# @return [void]
# @since 0.6.2
#
- # source://yard//lib/yard/server.rb#8
+ # source://yard//lib/yard/server.rb#17
def register_static_path(path); end
end
end
@@ -12835,7 +12826,7 @@ YARD::Server::CRLF = T.let(T.unsafe(nil), String)
#
# @since 0.6.0
#
-# source://yard//lib/yard/autoload.rb#219
+# source://yard//lib/yard/autoload.rb#235
module YARD::Server::Commands; end
# This is the base command class used to implement custom commands for
@@ -12867,8 +12858,10 @@ module YARD::Server::Commands; end
# @see #run
# @since 0.6.0
#
-# source://yard//lib/yard/server/commands/base.rb#34
+# source://yard//lib/yard/server/commands/base.rb#32
class YARD::Server::Commands::Base
+ include ::YARD::Server::StaticCaching
+
# Creates a new command object, setting attributes named by keys
# in the options hash. After initialization, the options hash
# is saved in {#command_options} for further inspection.
@@ -13036,7 +13029,7 @@ class YARD::Server::Commands::Base
# @return [void]
# @since 0.6.0
#
- # source://yard//lib/yard/server/commands/base.rb#180
+ # source://yard//lib/yard/server/commands/base.rb#174
def not_found; end
# Sets the headers and status code for a redirection to a given URL
@@ -13045,7 +13038,7 @@ class YARD::Server::Commands::Base
# @raise [FinishRequest] causes the request to terminate.
# @since 0.6.0
#
- # source://yard//lib/yard/server/commands/base.rb#192
+ # source://yard//lib/yard/server/commands/base.rb#186
def redirect(url); end
# Renders a specific object if provided, or a regular template rendering
@@ -13068,7 +13061,7 @@ class YARD::Server::Commands::Base
#
# @since 0.6.0
#
- # source://yard//lib/yard/server/commands/base.rb#202
+ # source://yard//lib/yard/server/commands/base.rb#196
def add_cache_control; end
end
@@ -14248,7 +14241,7 @@ class YARD::Server::LibraryNotPreparedError < ::RuntimeError; end
# def load_yardoc_from_http
# Thread.new do
# # zip/unzip method implementations are not shown
-# download_zip_file("http://mysite.com/yardocs/#{self}.zip")
+# download_zip_file("https://mysite.com/yardocs/#{self}.zip")
# unzip_file_to("/path/to/yardocs/#{self}")
# end
#
@@ -14679,16 +14672,24 @@ end
# @see Router Router documentation for "Caching"
# @since 0.6.0
#
-# source://yard//lib/yard/server/static_caching.rb#7
+# source://yard//lib/yard/server/static_caching.rb#9
module YARD::Server::StaticCaching
+ # Caches rendered HTML response data to disk.
+ #
+ # @param data [String] the data to cache
+ # @return [void]
+ # @since 0.9.44
+ #
+ # source://yard//lib/yard/server/static_caching.rb#52
+ def cache(data); end
+
# Called by a router to return the cached object. By default, this
# method performs disk-based caching. To perform other forms of caching,
# implement your own +#check_static_cache+ method and mix the module into
# the Router class.
#
- # Note that caching does not occur here. This method simply checks for
- # the existence of cached data. To actually cache a response, see
- # {Commands::Base#cache}.
+ # This method checks for the existence of cached data. To actually cache
+ # a response, see {#cache}.
#
# @example Implementing In-Memory Cache Checking
# module MemoryCaching
@@ -14709,13 +14710,20 @@ module YARD::Server::StaticCaching
# @see Commands::Base#cache
# @since 0.6.0
#
- # source://yard//lib/yard/server/static_caching.rb#34
+ # source://yard//lib/yard/server/static_caching.rb#35
def check_static_cache; end
-end
-# Stubs marshal dumps and acts a delegate class for an object by path
-#
-# @private
+ private
+
+ # @since 0.6.0
+ #
+ # source://yard//lib/yard/server/static_caching.rb#65
+ def cache_path(request_path); end
+end
+
+# Stubs marshal dumps and acts a delegate class for an object by path
+#
+# @private
#
# source://yard//lib/yard/serializers/yardoc_serializer.rb#6
class YARD::StubProxy
@@ -14749,7 +14757,7 @@ YARD::TEMPLATE_ROOT = T.let(T.unsafe(nil), String)
# Namespace for Tag components
#
-# source://yard//lib/yard/autoload.rb#248
+# source://yard//lib/yard/autoload.rb#264
module YARD::Tags; end
# Defines an attribute with a given name, using indented block data as the
@@ -15463,7 +15471,7 @@ class YARD::Tags::Library
#
# @example
# # Synchronizes system time using NTP.
- # # @see http://ntp.org/documentation.html NTP Documentation
+ # # @see https://ntp.org/documentation.html NTP Documentation
# # @see NTPHelperMethods
# class NTPUpdater; end
#
@@ -15511,7 +15519,7 @@ class YARD::Tags::Library
# @example
# # @todo Add support for Jabberwocky service.
# # There is an open source Jabberwocky library available
- # # at http://jbrwcky.org that can be easily integrated.
+ # # at https://jbrwcky.org that can be easily integrated.
# class Wonderlander; end
# @see tag:note
#
@@ -15526,7 +15534,7 @@ class YARD::Tags::Library
# of a specific object.
#
# @example
- # # The public REST API for http://jbrwcky.org
+ # # The public REST API for https://jbrwcky.org
# # @version 2.0
# class JabberwockyAPI; end
#
@@ -16187,11 +16195,11 @@ end
# def method2; end
# @since 0.7.0
#
-# source://yard//lib/yard/tags/directives.rb#578
+# source://yard//lib/yard/tags/directives.rb#585
class YARD::Tags::ScopeDirective < ::YARD::Tags::Directive
# @since 0.7.0
#
- # source://yard//lib/yard/tags/directives.rb#579
+ # source://yard//lib/yard/tags/directives.rb#586
def call; end
end
@@ -16216,7 +16224,7 @@ class YARD::Tags::Tag
# +raise+, etc.
#
# @param tag_name [#to_s] the tag name to create the tag for
- # @param text [String] the descriptive text for this tag
+ # @param text [String, nil] the descriptive text for this tag, or nil if none provided
# @param types [Array] optional type list of formally declared types
# for the tag
# @param name [String] optional key name which the tag refers to
@@ -16313,7 +16321,7 @@ class YARD::Tags::TypesExplainer
# @return [String] a plain English description of the associated types
# @return [nil] if no types are provided or not parsable
#
- # source://yard//lib/yard/tags/types_explainer.rb#9
+ # source://yard//lib/yard/tags/types_explainer.rb#12
def explain(*types); end
# Provides a plain English summary of the type specification, or nil
@@ -16324,7 +16332,7 @@ class YARD::Tags::TypesExplainer
# @return [String] a plain English description of the associated types
# @return [nil] if no types are provided or not parsable
#
- # source://yard//lib/yard/tags/types_explainer.rb#17
+ # source://yard//lib/yard/tags/types_explainer.rb#20
def explain!(*types); end
private
@@ -16335,125 +16343,166 @@ end
# @private
#
-# source://yard//lib/yard/tags/types_explainer.rb#58
+# source://yard//lib/yard/tags/types_explainer.rb#73
class YARD::Tags::TypesExplainer::CollectionType < ::YARD::Tags::TypesExplainer::Type
# @return [CollectionType] a new instance of CollectionType
#
- # source://yard//lib/yard/tags/types_explainer.rb#61
+ # source://yard//lib/yard/tags/types_explainer.rb#76
def initialize(name, types); end
- # source://yard//lib/yard/tags/types_explainer.rb#66
+ # source://yard//lib/yard/tags/types_explainer.rb#81
def to_s(_singular = T.unsafe(nil)); end
# Returns the value of attribute types.
#
- # source://yard//lib/yard/tags/types_explainer.rb#59
+ # source://yard//lib/yard/tags/types_explainer.rb#74
def types; end
# Sets the attribute types
#
# @param value the value to set the attribute types to.
#
- # source://yard//lib/yard/tags/types_explainer.rb#59
+ # source://yard//lib/yard/tags/types_explainer.rb#74
def types=(_arg0); end
end
# @private
#
-# source://yard//lib/yard/tags/types_explainer.rb#72
+# source://yard//lib/yard/tags/types_explainer.rb#66
+class YARD::Tags::TypesExplainer::DuckType < ::YARD::Tags::TypesExplainer::Type
+ # source://yard//lib/yard/tags/types_explainer.rb#67
+ def to_s(singular = T.unsafe(nil)); end
+end
+
+# @private
+#
+# source://yard//lib/yard/tags/types_explainer.rb#87
class YARD::Tags::TypesExplainer::FixedCollectionType < ::YARD::Tags::TypesExplainer::CollectionType
- # source://yard//lib/yard/tags/types_explainer.rb#73
+ # source://yard//lib/yard/tags/types_explainer.rb#88
def to_s(_singular = T.unsafe(nil)); end
end
# @private
#
-# source://yard//lib/yard/tags/types_explainer.rb#79
+# source://yard//lib/yard/tags/types_explainer.rb#94
class YARD::Tags::TypesExplainer::HashCollectionType < ::YARD::Tags::TypesExplainer::Type
# @return [HashCollectionType] a new instance of HashCollectionType
#
- # source://yard//lib/yard/tags/types_explainer.rb#82
- def initialize(name, key_types, value_types); end
+ # source://yard//lib/yard/tags/types_explainer.rb#97
+ def initialize(name, key_types_or_pairs, value_types = T.unsafe(nil)); end
- # Returns the value of attribute key_types.
+ # Backward compatibility accessors
#
- # source://yard//lib/yard/tags/types_explainer.rb#80
+ # source://yard//lib/yard/tags/types_explainer.rb#110
def key_types; end
- # Sets the attribute key_types
+ # source://yard//lib/yard/tags/types_explainer.rb#115
+ def key_types=(types); end
+
+ # Returns the value of attribute key_value_pairs.
+ #
+ # source://yard//lib/yard/tags/types_explainer.rb#95
+ def key_value_pairs; end
+
+ # Sets the attribute key_value_pairs
#
- # @param value the value to set the attribute key_types to.
+ # @param value the value to set the attribute key_value_pairs to.
#
- # source://yard//lib/yard/tags/types_explainer.rb#80
- def key_types=(_arg0); end
+ # source://yard//lib/yard/tags/types_explainer.rb#95
+ def key_value_pairs=(_arg0); end
- # source://yard//lib/yard/tags/types_explainer.rb#88
+ # source://yard//lib/yard/tags/types_explainer.rb#136
def to_s(_singular = T.unsafe(nil)); end
- # Returns the value of attribute value_types.
- #
- # source://yard//lib/yard/tags/types_explainer.rb#80
+ # source://yard//lib/yard/tags/types_explainer.rb#123
def value_types; end
- # Sets the attribute value_types
- #
- # @param value the value to set the attribute value_types to.
- #
- # source://yard//lib/yard/tags/types_explainer.rb#80
- def value_types=(_arg0); end
+ # source://yard//lib/yard/tags/types_explainer.rb#128
+ def value_types=(types); end
end
+# Regular expression to match symbol and string literals
+#
+# source://yard//lib/yard/tags/types_explainer.rb#8
+YARD::Tags::TypesExplainer::LITERALMATCH = T.let(T.unsafe(nil), Regexp)
+
# @private
#
-# source://yard//lib/yard/tags/types_explainer.rb#96
+# source://yard//lib/yard/tags/types_explainer.rb#59
+class YARD::Tags::TypesExplainer::LiteralType < ::YARD::Tags::TypesExplainer::Type
+ # source://yard//lib/yard/tags/types_explainer.rb#60
+ def to_s(_singular = T.unsafe(nil)); end
+end
+
+# @private
+#
+# source://yard//lib/yard/tags/types_explainer.rb#149
class YARD::Tags::TypesExplainer::Parser
include ::YARD::CodeObjects
# @return [Parser] a new instance of Parser
#
- # source://yard//lib/yard/tags/types_explainer.rb#117
+ # source://yard//lib/yard/tags/types_explainer.rb#173
def initialize(string); end
- # source://yard//lib/yard/tags/types_explainer.rb#121
- def parse; end
+ # @return [Array(Boolean, Array)] - finished, types
+ #
+ # source://yard//lib/yard/tags/types_explainer.rb#178
+ def parse(until_tokens: T.unsafe(nil)); end
+
+ private
+
+ # source://yard//lib/yard/tags/types_explainer.rb#285
+ def create_type(name); end
+
+ # source://yard//lib/yard/tags/types_explainer.rb#241
+ def parse_hash_collection(name); end
+
+ # source://yard//lib/yard/tags/types_explainer.rb#184
+ def parse_until(until_tokens); end
+
+ # @return [Array]
+ #
+ # source://yard//lib/yard/tags/types_explainer.rb#223
+ def parse_with_handlers; end
class << self
- # source://yard//lib/yard/tags/types_explainer.rb#113
+ # source://yard//lib/yard/tags/types_explainer.rb#169
def parse(string); end
end
end
-# source://yard//lib/yard/tags/types_explainer.rb#99
+# source://yard//lib/yard/tags/types_explainer.rb#152
YARD::Tags::TypesExplainer::Parser::TOKENS = T.let(T.unsafe(nil), Hash)
# @private
#
-# source://yard//lib/yard/tags/types_explainer.rb#26
+# source://yard//lib/yard/tags/types_explainer.rb#29
class YARD::Tags::TypesExplainer::Type
# @return [Type] a new instance of Type
#
- # source://yard//lib/yard/tags/types_explainer.rb#29
+ # source://yard//lib/yard/tags/types_explainer.rb#32
def initialize(name); end
# Returns the value of attribute name.
#
- # source://yard//lib/yard/tags/types_explainer.rb#27
+ # source://yard//lib/yard/tags/types_explainer.rb#30
def name; end
# Sets the attribute name
#
# @param value the value to set the attribute name to.
#
- # source://yard//lib/yard/tags/types_explainer.rb#27
+ # source://yard//lib/yard/tags/types_explainer.rb#30
def name=(_arg0); end
- # source://yard//lib/yard/tags/types_explainer.rb#33
+ # source://yard//lib/yard/tags/types_explainer.rb#36
def to_s(singular = T.unsafe(nil)); end
- private
+ protected
- # source://yard//lib/yard/tags/types_explainer.rb#45
- def list_join(list); end
+ # source://yard//lib/yard/tags/types_explainer.rb#46
+ def list_join(list, with: T.unsafe(nil)); end
end
# Modifies the current parsing visibility (public, protected, or private).
@@ -16475,17 +16524,17 @@ end
# def method2; end
# @since 0.7.0
#
-# source://yard//lib/yard/tags/directives.rb#610
+# source://yard//lib/yard/tags/directives.rb#617
class YARD::Tags::VisibilityDirective < ::YARD::Tags::Directive
# @since 0.7.0
#
- # source://yard//lib/yard/tags/directives.rb#611
+ # source://yard//lib/yard/tags/directives.rb#618
def call; end
end
# Namespace for templating system
#
-# source://yard//lib/yard/autoload.rb#271
+# source://yard//lib/yard/autoload.rb#287
module YARD::Templates; end
# This module manages all creation, handling and rendering of {Template}
@@ -16638,7 +16687,7 @@ end
# Namespace for template helpers
#
-# source://yard//lib/yard/autoload.rb#272
+# source://yard//lib/yard/autoload.rb#288
module YARD::Templates::Helpers; end
# The base helper module included in all templates.
@@ -16756,7 +16805,7 @@ module YARD::Templates::Helpers::BaseHelper
# method depending on the arguments passed in.
#
# @example Linking a URL
- # linkify('http://example.com')
+ # linkify('https://example.com')
# @example Including docstring contents of an object
# linkify('include:YARD::Docstring')
# @example Linking to an extra file
@@ -16835,7 +16884,7 @@ end
# The helper module for HTML templates.
#
-# source://yard//lib/yard/templates/helpers/html_helper.rb#7
+# source://yard//lib/yard/templates/helpers/html_helper.rb#11
module YARD::Templates::Helpers::HtmlHelper
include ::YARD::Templates::Helpers::MarkupHelper
include ::YARD::Templates::Helpers::ModuleHelper
@@ -16844,7 +16893,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @param object [CodeObjects::Base] the object to get an anchor for
# @return [String] the anchor for a specific object
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#347
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#357
def anchor_for(object); end
# Returns the current character set. The default value can be overridden
@@ -16855,14 +16904,14 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the current character set
# @since 0.5.4
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#574
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#584
def charset; end
# Formats a list of objects and links them
#
# @return [String] a formatted list of objects
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#458
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#468
def format_object_name_list(objects); end
# Formats a list of types from a tag.
@@ -16874,7 +16923,7 @@ module YARD::Templates::Helpers::HtmlHelper
# as [Type1, Type2, ...] with the types linked
# to their respective descriptions.
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#476
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#486
def format_types(typelist, brackets = T.unsafe(nil)); end
# Escapes HTML entities
@@ -16882,7 +16931,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @param text [String] the text to escape
# @return [String] the HTML with escaped entities
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#23
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#27
def h(text); end
# Converts Asciidoc to HTML
@@ -16890,7 +16939,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @param text [String] input Asciidoc text
# @return [String] output HTML
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#109
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#119
def html_markup_asciidoc(text); end
# Converts HTML to HTML
@@ -16899,7 +16948,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] output HTML
# @since 0.6.0
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#168
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#178
def html_markup_html(text); end
# Converts Markdown to HTML
@@ -16908,13 +16957,13 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] output HTML
# @since 0.6.0
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#78
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#82
def html_markup_markdown(text); end
# @return [String] the same text with no markup
# @since 0.6.6
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#160
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#170
def html_markup_none(text); end
# Converts org-mode to HTML
@@ -16922,7 +16971,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @param text [String] input org-mode text
# @return [String] output HTML
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#102
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#112
def html_markup_org(text); end
# Converts plaintext to pre-formatted HTML
@@ -16931,7 +16980,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the output HTML
# @since 0.6.0
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#146
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#156
def html_markup_pre(text); end
# Converts RDoc formatting (SimpleMarkup) to HTML
@@ -16940,7 +16989,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] output HTML
# @since 0.6.0
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#136
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#146
def html_markup_rdoc(text); end
# Highlights Ruby source. Similar to {#html_syntax_highlight}, but
@@ -16951,7 +17000,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the highlighted HTML
# @since 0.7.0
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#179
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#189
def html_markup_ruby(source); end
# Converts plaintext to regular HTML
@@ -16960,7 +17009,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the output HTML
# @since 0.6.0
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#154
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#164
def html_markup_text(text); end
# Converts Textile to HTML
@@ -16969,7 +17018,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] output HTML
# @since 0.6.0
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#118
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#128
def html_markup_textile(text); end
# Converts plaintext to strict Textile (hard breaks)
@@ -16978,7 +17027,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the output HTML
# @since 0.6.0
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#128
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#138
def html_markup_textile_strict(text); end
# Syntax highlights +source+ in language +type+.
@@ -16990,12 +17039,12 @@ module YARD::Templates::Helpers::HtmlHelper
# :plain for no syntax highlighting.
# @return [String] the highlighted source
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#199
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#209
def html_syntax_highlight(source, type = T.unsafe(nil)); end
# @return [String] unhighlighted source
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#210
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#220
def html_syntax_highlight_plain(source); end
# Turns text into HTML using +markup+ style formatting.
@@ -17005,17 +17054,17 @@ module YARD::Templates::Helpers::HtmlHelper
# To add a custom markup type, see {MarkupHelper}
# @return [String] the HTML
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#57
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#61
def htmlify(text, markup = T.unsafe(nil)); end
# @return [String] HTMLified text as a single line (paragraphs removed)
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#184
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#194
def htmlify_line(*args); end
# Inserts an include link while respecting inlining
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#296
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#306
def insert_include(text, markup = T.unsafe(nil)); end
# Links to an extra file
@@ -17026,7 +17075,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the link to the file
# @since 0.5.5
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#270
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#280
def link_file(filename, title = T.unsafe(nil), anchor = T.unsafe(nil)); end
# Include a file as a docstring in output
@@ -17035,7 +17084,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the file's contents
# @since 0.7.0
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#282
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#292
def link_include_file(file); end
# Includes an object's docstring into output.
@@ -17044,7 +17093,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the object's docstring (no tags)
# @since 0.6.0
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#291
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#301
def link_include_object(obj); end
# Links to an object with an optional title
@@ -17053,7 +17102,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @param title [String] the title to use for the link
# @return [String] the linked object
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#301
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#311
def link_object(obj, title = T.unsafe(nil), anchor = T.unsafe(nil), relative = T.unsafe(nil)); end
# Links to a URL
@@ -17063,10 +17112,10 @@ module YARD::Templates::Helpers::HtmlHelper
# @param params [Hash] optional parameters for the link
# @return [String] the linked URL
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#332
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#342
def link_url(url, title = T.unsafe(nil), params = T.unsafe(nil)); end
- # source://yard//lib/yard/templates/helpers/html_helper.rb#400
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#410
def mtime(_file); end
# Returns the URL for an object.
@@ -17076,7 +17125,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @param relative [Boolean] use a relative or absolute link
# @return [String] the URL location of the object
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#368
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#378
def mtime_url(obj, anchor = T.unsafe(nil), relative = T.unsafe(nil)); end
# Resolves any text in the form of +{Name}+ to the object specified by
@@ -17089,7 +17138,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @param text [String] the text to resolve links in
# @return [String] HTML with linkified references
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#225
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#235
def resolve_links(text); end
# Formats the signature of method +meth+.
@@ -17102,7 +17151,7 @@ module YARD::Templates::Helpers::HtmlHelper
# ("name=" instead of "name")
# @return [String] the formatted method signature
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#529
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#539
def signature(meth, link = T.unsafe(nil), show_extras = T.unsafe(nil), full_attr_name = T.unsafe(nil)); end
# Get the return types for a method signature.
@@ -17112,7 +17161,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the signature types
# @since 0.5.3
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#492
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#502
def signature_types(meth, link = T.unsafe(nil)); end
# Returns the URL for an object.
@@ -17122,7 +17171,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @param relative [Boolean] use a relative or absolute link
# @return [String] the URL location of the object
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#368
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#378
def url_for(obj, anchor = T.unsafe(nil), relative = T.unsafe(nil)); end
# Returns the URL for a specific file
@@ -17131,7 +17180,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @param anchor [String] optional anchor
# @return [String] the URL pointing to the file
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#407
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#417
def url_for_file(filename, anchor = T.unsafe(nil)); end
# Returns the URL for the frameset page
@@ -17139,7 +17188,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the URL pointing to the frames page
# @since 0.8.0
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#434
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#444
def url_for_frameset; end
# Returns the URL for the alphabetic index page
@@ -17147,7 +17196,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the URL pointing to the first main page the
# user should see.
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#450
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#460
def url_for_index; end
# Returns the URL for a list type
@@ -17156,7 +17205,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the URL pointing to the list
# @since 0.8.0
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#426
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#436
def url_for_list(type); end
# Returns the URL for the main page (README or alphabetic index)
@@ -17164,7 +17213,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] the URL pointing to the first main page the
# user should see.
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#442
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#452
def url_for_main; end
private
@@ -17173,7 +17222,7 @@ module YARD::Templates::Helpers::HtmlHelper
#
# @since 0.5.3
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#609
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#619
def convert_method_to_overload(meth); end
# Parses code block's HTML attributes in order to detect the programming
@@ -17184,7 +17233,7 @@ module YARD::Templates::Helpers::HtmlHelper
# element
# @return [String, nil] detected programming language
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#664
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#679
def detect_lang_in_codeblock_attributes(pre_html_attrs, code_html_attrs); end
# Parses code blocks out of html and performs syntax highlighting
@@ -17194,7 +17243,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @return [String] highlighted html
# @see #html_syntax_highlight
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#640
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#650
def parse_codeblocks(html); end
# Parses !!!lang out of codeblock, returning the codeblock language
@@ -17205,7 +17254,7 @@ module YARD::Templates::Helpers::HtmlHelper
# remaining source
# @since 0.7.5
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#624
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#634
def parse_lang_for_codeblock(source); end
# Converts a set of hash options into HTML attributes for a tag
@@ -17213,7 +17262,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @param opts [Hash{String => String}] the tag options
# @return [String] the tag attributes of an HTML tag
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#603
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#613
def tag_attrs(opts = T.unsafe(nil)); end
# Escapes a URL
@@ -17221,7 +17270,7 @@ module YARD::Templates::Helpers::HtmlHelper
# @param text [String] the URL
# @return [String] the escaped URL
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#31
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#35
def urlencode(text); end
class << self
@@ -17230,19 +17279,19 @@ module YARD::Templates::Helpers::HtmlHelper
# @param text [String] the URL
# @return [String] the escaped URL
#
- # source://yard//lib/yard/templates/helpers/html_helper.rb#31
+ # source://yard//lib/yard/templates/helpers/html_helper.rb#35
def urlencode(text); end
end
end
# @private
#
-# source://yard//lib/yard/templates/helpers/html_helper.rb#15
+# source://yard//lib/yard/templates/helpers/html_helper.rb#19
YARD::Templates::Helpers::HtmlHelper::ASCIIDOC_ATTRIBUTES = T.let(T.unsafe(nil), Hash)
# @private
#
-# source://yard//lib/yard/templates/helpers/html_helper.rb#12
+# source://yard//lib/yard/templates/helpers/html_helper.rb#16
YARD::Templates::Helpers::HtmlHelper::URLMATCH = T.let(T.unsafe(nil), Regexp)
# Helper methods for syntax highlighting.
@@ -17256,106 +17305,594 @@ module YARD::Templates::Helpers::HtmlSyntaxHighlightHelper
# @param source [String] the Ruby source code
# @return [String] the highlighted Ruby source
#
- # source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#12
+ # source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#17
def html_syntax_highlight_ruby(source); end
private
- # source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#63
+ # source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#68
def clean_token_object(token_obj); end
- # source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#45
+ # source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#50
def html_syntax_highlight_ruby_legacy(source); end
- # source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#22
+ # source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#27
def html_syntax_highlight_ruby_ripper(source); end
end
+# Matches source that has already been highlighted (i.e. contains a span tag).
+# Used to avoid double-processing pre-highlighted HTML in the rescue clause of
+# {#html_syntax_highlight_ruby_ripper} and in the {HtmlHelper#parse_codeblocks} guard.
+#
+# source://yard//lib/yard/templates/helpers/html_syntax_highlight_helper.rb#12
+YARD::Templates::Helpers::HtmlSyntaxHighlightHelper::ALREADY_HIGHLIGHTED_RE = T.let(T.unsafe(nil), Regexp)
+
# Namespace for markup providers
#
-# source://yard//lib/yard/autoload.rb#273
+# source://yard//lib/yard/autoload.rb#289
module YARD::Templates::Helpers::Markup; end
-# source://yard//lib/yard/templates/helpers/markup/rdoc_markdown.rb#13
-class YARD::Templates::Helpers::Markup::RDocMarkdown < ::YARD::Templates::Helpers::Markup::RDocMarkup
- # @return [RDocMarkdown] a new instance of RDocMarkdown
- #
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markdown.rb#14
- def initialize(text); end
+# source://yard//lib/yard/templates/helpers/markup/html_entities.rb#7
+module YARD::Templates::Helpers::Markup::HtmlEntities; end
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markdown.rb#18
- def fix_typewriter(html); end
-end
+# HTML named character references from WHATWG entities.json.
+#
+# source://yard//lib/yard/templates/helpers/markup/html_entities.rb#9
+YARD::Templates::Helpers::Markup::HtmlEntities::ENTITIES = T.let(T.unsafe(nil), Hash)
-# source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#12
-class YARD::Templates::Helpers::Markup::RDocMarkup
- # @return [RDocMarkup] a new instance of RDocMarkup
+# A built-in formatter that implements a practical subset of GitHub
+# flavored Markdown plus common RDoc markup forms.
+#
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#14
+class YARD::Templates::Helpers::Markup::HybridMarkdown
+ # @option options
+ # @param text [String] the Markdown text to format.
+ # @param options [Hash] options for the formatter.
+ # @return [HybridMarkdown] a new instance of HybridMarkdown
#
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#41
- def initialize(text); end
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#74
+ def initialize(text, options = T.unsafe(nil)); end
# Returns the value of attribute from_path.
#
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#35
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#15
def from_path; end
# Sets the attribute from_path
#
# @param value the value to set the attribute from_path to.
#
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#35
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#15
def from_path=(_arg0); end
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#50
+ # @return [String] the formatted HTML.
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#81
def to_html; end
private
- # Don't allow -- to turn into — element. The chances of this being
- # some --option is far more likely than the typographical meaning.
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2107
+ def append_folded_codepoint(buffer, codepoint); end
+
+ # @return [Boolean]
#
- # @todo Refactor into own SimpleMarkup subclass
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2080
+ def ascii_only_compat?(text); end
+
+ # @return [Boolean]
#
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#87
- def fix_dash_dash(text); end
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1602
+ def ascii_punctuation_char?(char); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#799
+ def autolink_urls(text); end
- # Fixes RDoc behaviour with ++ only supporting alphanumeric text.
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1544
+ def available_delimiter_length(token); end
+
+ # @return [Boolean]
#
- # @todo Refactor into own SimpleMarkup subclass
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#893
+ def blank_line?(line); end
+
+ # @return [Boolean]
#
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#66
- def fix_typewriter(text); end
-end
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1136
+ def block_boundary?(line); end
-# source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#12
-YARD::Templates::Helpers::Markup::RDocMarkup::MARKUP = RDoc::Markup
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1992
+ def blockquote_open_fence?(quoted_lines); end
-# source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#13
-class YARD::Templates::Helpers::Markup::RDocMarkupToHtml < ::RDoc::Markup::ToHtml
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#16
- def initialize; end
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2008
+ def blockquote_paragraph_context?(quoted_lines); end
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#100
- def accept_paragraph(*args); end
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#958
+ def blockquote_start?(line); end
- # Returns the value of attribute from_path.
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1001
+ def code_block(text, lang = T.unsafe(nil)); end
+
+ # @return [Boolean]
#
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#93
- def from_path; end
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#924
+ def colon_indented_code_block_start?(lines, index); end
- # Sets the attribute from_path
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1928
+ def consume_columns(text, columns, start_column = T.unsafe(nil), normalize_remaining = T.unsafe(nil)); end
+
+ # @return [Boolean]
#
- # @param value the value to set the attribute from_path to.
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1763
+ def contains_nested_link?(label, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1521
+ def decode_entities(text); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1855
+ def decode_entity(entity); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1557
+ def delimiter_flags(text, run_start, run_end, char); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2072
+ def each_char_compat(text); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1645
+ def escape_autolink_url(url); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1626
+ def escape_list_marker_text(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1641
+ def escape_url(url); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1007
+ def extract_codeblock_language(text, lang = T.unsafe(nil)); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#828
+ def extract_reference_definitions(text); end
+
+ # @return [Boolean]
#
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#93
- def from_path=(_arg0); end
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1056
+ def fence_closer?(line, char, min_length); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#905
+ def fenced_code_start?(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1487
+ def find_braced_text_link_label_end(text, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1321
+ def find_closing_bracket(text, open_index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1339
+ def find_matching_backtick_run(text, index, length); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1744
+ def find_reference_label_end(text); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#728
+ def format_emphasis(text); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#510
+ def format_inline(text); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#795
+ def format_strikethrough(text); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1873
+ def h(text); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1023
+ def heading_id(text); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1836
+ def html_block_end?(type, line); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#962
+ def html_block_start?(line, interrupt_paragraph = T.unsafe(nil)); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1819
+ def html_block_type(line, interrupt_paragraph = T.unsafe(nil)); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1513
+ def image_html(label, dest, title = T.unsafe(nil)); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#913
+ def indented_code_block_start?(lines, index, previous_block_type = T.unsafe(nil)); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#909
+ def indented_code_start?(line); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1618
+ def indented_to?(line, indent); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#564
+ def inside_angle_autolink_candidate?(text, index); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#952
+ def labeled_list_start?(lines, index); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1981
+ def lazy_blockquote_continuation?(quoted_lines, line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1614
+ def leading_columns(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1505
+ def link_html(label, dest, title = T.unsafe(nil)); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1125
+ def list_item_padding(marker); end
- # Disable auto-link of URLs
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#943
+ def list_start?(line, interrupt_paragraph = T.unsafe(nil)); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2047
+ def loose_list_item_continuation?(item_lines); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1535
+ def normalize_code_span(code); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2022
+ def normalize_heading_line(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2018
+ def normalize_paragraph_line(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#870
+ def normalize_reference_label(label); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1548
+ def odd_match_disallowed?(opener, closer); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2056
+ def open_fence_in_lines?(lines); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1029
+ def parse_atx_heading(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#428
+ def parse_blockquote(lines, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#87
+ def parse_blocks(lines, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1043
+ def parse_fence_opener(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#201
+ def parse_fenced_code(lines, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#150
+ def parse_heading(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#464
+ def parse_html_block(lines, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#221
+ def parse_indented_code(lines, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1355
+ def parse_inline_destination(text, index, placeholders = T.unsafe(nil)); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#393
+ def parse_labeled_list(lines, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#822
+ def parse_labeled_list_line(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#281
+ def parse_list(lines, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1070
+ def parse_list_marker(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#485
+ def parse_paragraph(lines, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1142
+ def parse_reference_definition(label, definition); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1649
+ def parse_reference_definition_block(lines, index, previous_line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#166
+ def parse_setext_heading(lines, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#252
+ def parse_table(lines, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1458
+ def parse_text_link_destination(text, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#238
+ def parse_yard_indented_code(lines, index); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1803
+ def percent_encode_url(text, allowed_re); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1451
+ def plain_text(text); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#588
+ def protect_autolinks(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#696
+ def protect_braced_text_links(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#533
+ def protect_code_spans(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#616
+ def protect_entities(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#608
+ def protect_escaped_characters(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#620
+ def protect_hard_breaks(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#632
+ def protect_inline_images(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#642
+ def protect_inline_links(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#596
+ def protect_raw_html(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#624
+ def protect_rdoc_images(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#652
+ def protect_reference_images(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#656
+ def protect_reference_links(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#660
+ def protect_single_word_text_links(text, placeholders); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#577
+ def protect_yard_links(text, placeholders); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1582
+ def punctuation_char?(char); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1718
+ def reference_definition_context?(previous_line); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1527
+ def reference_definition_continuation?(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1738
+ def reference_definition_replacement_line(line, prefix); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#884
+ def reference_image_html(alt, ref); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#875
+ def reference_link_html(label, ref); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1204
+ def replace_inline_constructs(text, placeholders, prefix); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#813
+ def restore_placeholders(text, placeholders); end
+
+ # @return [Boolean]
#
- # source://yard//lib/yard/templates/helpers/markup/rdoc_markup.rb#96
- def handle_special_HYPERLINK(special); end
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1129
+ def same_list_type?(base, other); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1885
+ def scan_leading_columns(text); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1905
+ def scan_padding_columns(text, index, start_column); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1252
+ def scan_reference_constructs(text, placeholders, kind); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#901
+ def setext_underline_line?(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2026
+ def split_blockquote_prefix(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1881
+ def split_lines(text); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1726
+ def split_reference_container_prefix(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#976
+ def split_table_row(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#817
+ def store_placeholder(placeholders, html); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2042
+ def strip_blockquote_marker(line); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1064
+ def strip_fenced_indent(line, indent); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1622
+ def strip_list_item_indent(line, content_indent); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1014
+ def strip_trailing_punctuation(url); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#980
+ def table_alignment(cell); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#971
+ def table_row?(line); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#966
+ def table_start?(lines, index); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#897
+ def thematic_break?(line); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1791
+ def unclosed_reference_title?(text); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1877
+ def unescape_markdown_punctuation(text); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2096
+ def unicode_casefold_compat(text); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1588
+ def unicode_symbol_char?(char); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#989
+ def unindent(lines); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#997
+ def unindent_indented_code(lines); end
+
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#2088
+ def utf8_bytes(char); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#1578
+ def whitespace_char?(char); end
+
+ # @return [Boolean]
+ #
+ # source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#935
+ def yard_indented_code_start?(lines, index); end
end
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#17
+YARD::Templates::Helpers::Markup::HybridMarkdown::ATX_HEADING_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#68
+YARD::Templates::Helpers::Markup::HybridMarkdown::AUTOLINK_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#28
+YARD::Templates::Helpers::Markup::HybridMarkdown::BLOCKQUOTE_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#63
+YARD::Templates::Helpers::Markup::HybridMarkdown::CODE_LANG_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#61
+YARD::Templates::Helpers::Markup::HybridMarkdown::ENTITY_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#66
+YARD::Templates::Helpers::Markup::HybridMarkdown::ESCAPABLE_CHARS_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#20
+YARD::Templates::Helpers::Markup::HybridMarkdown::FENCE_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#29
+YARD::Templates::Helpers::Markup::HybridMarkdown::HTML_BLOCK_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#41
+YARD::Templates::Helpers::Markup::HybridMarkdown::HTML_BLOCK_TAGS = T.let(T.unsafe(nil), Array)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#48
+YARD::Templates::Helpers::Markup::HybridMarkdown::HTML_TAG_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#26
+YARD::Templates::Helpers::Markup::HybridMarkdown::LABEL_LIST_BRACKET_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#27
+YARD::Templates::Helpers::Markup::HybridMarkdown::LABEL_LIST_COLON_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#24
+YARD::Templates::Helpers::Markup::HybridMarkdown::ORDERED_LIST_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#65
+YARD::Templates::Helpers::Markup::HybridMarkdown::PLACEHOLDER_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#67
+YARD::Templates::Helpers::Markup::HybridMarkdown::RDOC_ESCAPED_CAPITALIZED_CROSSREF_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#18
+YARD::Templates::Helpers::Markup::HybridMarkdown::RDOC_HEADING_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#25
+YARD::Templates::Helpers::Markup::HybridMarkdown::RDOC_ORDERED_LIST_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#64
+YARD::Templates::Helpers::Markup::HybridMarkdown::REFERENCE_DEF_START_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#19
+YARD::Templates::Helpers::Markup::HybridMarkdown::SETEXT_HEADING_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#22
+YARD::Templates::Helpers::Markup::HybridMarkdown::TABLE_SEPARATOR_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#69
+YARD::Templates::Helpers::Markup::HybridMarkdown::TAB_WIDTH = T.let(T.unsafe(nil), Integer)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#21
+YARD::Templates::Helpers::Markup::HybridMarkdown::THEMATIC_BREAK_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#23
+YARD::Templates::Helpers::Markup::HybridMarkdown::UNORDERED_LIST_RE = T.let(T.unsafe(nil), Regexp)
+
+# source://yard//lib/yard/templates/helpers/markup/hybrid_markdown.rb#62
+YARD::Templates::Helpers::Markup::HybridMarkdown::YARD_LINK_RE = T.let(T.unsafe(nil), Regexp)
+
# Helper methods for loading and managing markup types.
#
# source://yard//lib/yard/templates/helpers/markup_helper.rb#7
@@ -17372,7 +17909,7 @@ module YARD::Templates::Helpers::MarkupHelper
#
# @return [Boolean] whether the markup provider was successfully loaded.
#
- # source://yard//lib/yard/templates/helpers/markup_helper.rb#87
+ # source://yard//lib/yard/templates/helpers/markup_helper.rb#89
def load_markup_provider(type = T.unsafe(nil)); end
# Gets the markup provider class/module constant for a markup type
@@ -17381,7 +17918,7 @@ module YARD::Templates::Helpers::MarkupHelper
# @param type [Symbol] the markup type (:rdoc, :markdown, etc.)
# @return [Class] the markup class
#
- # source://yard//lib/yard/templates/helpers/markup_helper.rb#158
+ # source://yard//lib/yard/templates/helpers/markup_helper.rb#160
def markup_class(type = T.unsafe(nil)); end
# Strips any shebang lines on the file contents that pertain to
@@ -17391,7 +17928,7 @@ module YARD::Templates::Helpers::MarkupHelper
# @return [String] the file contents minus any preprocessing tags
# @since 0.6.0
#
- # source://yard//lib/yard/templates/helpers/markup_helper.rb#149
+ # source://yard//lib/yard/templates/helpers/markup_helper.rb#151
def markup_file_contents(contents); end
# Checks for a shebang or looks at the file extension to determine
@@ -17410,7 +17947,7 @@ module YARD::Templates::Helpers::MarkupHelper
# @see MARKUP_EXTENSIONS
# @since 0.6.0
#
- # source://yard//lib/yard/templates/helpers/markup_helper.rb#133
+ # source://yard//lib/yard/templates/helpers/markup_helper.rb#135
def markup_for_file(contents, filename); end
# Gets the markup provider name for a markup type
@@ -17419,7 +17956,7 @@ module YARD::Templates::Helpers::MarkupHelper
# @param type [Symbol] the markup type (:rdoc, :markdown, etc.)
# @return [Symbol] the markup provider name (usually the gem name of the library)
#
- # source://yard//lib/yard/templates/helpers/markup_helper.rb#168
+ # source://yard//lib/yard/templates/helpers/markup_helper.rb#170
def markup_provider(type = T.unsafe(nil)); end
class << self
@@ -17452,13 +17989,13 @@ end
#
# @since 0.6.0
#
-# source://yard//lib/yard/templates/helpers/markup_helper.rb#61
+# source://yard//lib/yard/templates/helpers/markup_helper.rb#63
YARD::Templates::Helpers::MarkupHelper::MARKUP_EXTENSIONS = T.let(T.unsafe(nil), Hash)
# Contains the Regexp object that matches the shebang line of extra
# files to detect the markup type.
#
-# source://yard//lib/yard/templates/helpers/markup_helper.rb#74
+# source://yard//lib/yard/templates/helpers/markup_helper.rb#76
YARD::Templates::Helpers::MarkupHelper::MARKUP_FILE_SHEBANG = T.let(T.unsafe(nil), Regexp)
# The default list of markup providers for each markup type