admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Update RBI files for yard.

Browse Source 
Autogenerated by the [vendor-gems](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/vendor-gems.yml) workflow.
This commit is contained in:
BrewTestBot 2024-02-28 18:51:31 +00:00
parent a2eeae11da
commit 605aea8ce2
No known key found for this signature in database
GPG Key ID: 82D7D104050B0F0F
1 changed files with 36 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
Library/Homebrew/sorbet/rbi/gems/yard@0.9.34.rbi → Library/Homebrew/sorbet/rbi/gems/yard@0.9.35.rbi generated
View File

@ -2480,7 +2480,7 @@ class YARD::CodeObjects::Base
# the paths are equal # the paths are equal
# @return [Boolean] whether or not the objects are considered the same # @return [Boolean] whether or not the objects are considered the same
# #
# source://yard//lib/yard/code_objects/base.rb#322 # source://yard//lib/yard/code_objects/base.rb#323
def ==(other); end def ==(other); end
# Accesses a custom attribute on the object # Accesses a custom attribute on the object
@ -2489,7 +2489,7 @@ class YARD::CodeObjects::Base
# @return [Object, nil] the custom attribute or nil if not found. # @return [Object, nil] the custom attribute or nil if not found.
# @see #[]= # @see #[]=
# #
# source://yard//lib/yard/code_objects/base.rb#342 # source://yard//lib/yard/code_objects/base.rb#343
def [](key); end def [](key); end
# Sets a custom attribute on the object # Sets a custom attribute on the object
@ -2499,7 +2499,7 @@ class YARD::CodeObjects::Base
# @return [void] # @return [void]
# @see #[] # @see #[]
# #
# source://yard//lib/yard/code_objects/base.rb#355 # source://yard//lib/yard/code_objects/base.rb#356
def []=(key, value); end def []=(key, value); end
# Associates a file with a code object, optionally adding the line where it was defined. # Associates a file with a code object, optionally adding the line where it was defined.
@ -2520,7 +2520,7 @@ class YARD::CodeObjects::Base
# @see Docstring#add_tag # @see Docstring#add_tag
# @since 0.8.4 # @since 0.8.4
# #
# source://yard//lib/yard/code_objects/base.rb#560 # source://yard//lib/yard/code_objects/base.rb#561
def add_tag(*tags); end def add_tag(*tags); end
# The non-localized documentation string associated with the object # The non-localized documentation string associated with the object
@ -2547,7 +2547,7 @@ class YARD::CodeObjects::Base
# the locale of the documentation string. # the locale of the documentation string.
# @return [Docstring] the documentation string # @return [Docstring] the documentation string
# #
# source://yard//lib/yard/code_objects/base.rb#404 # source://yard//lib/yard/code_objects/base.rb#405
def docstring(locale = T.unsafe(nil)); end def docstring(locale = T.unsafe(nil)); end
# Attaches a docstring to a code object by parsing the comments attached to the statement # Attaches a docstring to a code object by parsing the comments attached to the statement
@ -2556,7 +2556,7 @@ class YARD::CodeObjects::Base
# @param comments [String, Array<String>, Docstring] the comments attached to the code object to be parsed # @param comments [String, Array<String>, Docstring] the comments attached to the code object to be parsed
# into a docstring and meta tags. # into a docstring and meta tags.
# #
# source://yard//lib/yard/code_objects/base.rb#426 # source://yard//lib/yard/code_objects/base.rb#427
def docstring=(comments); end def docstring=(comments); end
# Marks whether or not the method is conditionally defined at runtime # Marks whether or not the method is conditionally defined at runtime
@ -2587,7 +2587,7 @@ class YARD::CodeObjects::Base
# the paths are equal # the paths are equal
# @return [Boolean] whether or not the objects are considered the same # @return [Boolean] whether or not the objects are considered the same
# #
# source://yard//lib/yard/code_objects/base.rb#322 # source://yard//lib/yard/code_objects/base.rb#323
def eql?(other); end def eql?(other); end
# Tests if another object is equal to this, including a proxy # Tests if another object is equal to this, including a proxy
@ -2596,15 +2596,16 @@ class YARD::CodeObjects::Base
# the paths are equal # the paths are equal
# @return [Boolean] whether or not the objects are considered the same # @return [Boolean] whether or not the objects are considered the same
# #
# source://yard//lib/yard/code_objects/base.rb#322 # source://yard//lib/yard/code_objects/base.rb#323
def equal?(other); end def equal?(other); end
# Returns the filename the object was first parsed at, taking # Returns the filename the object was first parsed at, taking
# definitions with docstrings first. # definitions with docstrings first.
# #
# @return [String] a filename # @return [String] a filename
# @return [nil] if there is no file associated with the object
# #
# source://yard//lib/yard/code_objects/base.rb#306 # source://yard//lib/yard/code_objects/base.rb#307
def file; end def file; end
# The files the object was defined in. To add a file, use {#add_file}. # The files the object was defined in. To add a file, use {#add_file}.
@ -2629,7 +2630,7 @@ class YARD::CodeObjects::Base
# @return [String] the rendered template # @return [String] the rendered template
# @see Templates::Engine#render # @see Templates::Engine#render
# #
# source://yard//lib/yard/code_objects/base.rb#504 # source://yard//lib/yard/code_objects/base.rb#505
def format(options = T.unsafe(nil)); end def format(options = T.unsafe(nil)); end
# @return [String] the group this object is associated with # @return [String] the group this object is associated with
@ -2649,19 +2650,19 @@ class YARD::CodeObjects::Base
# @return [Boolean] # @return [Boolean]
# @see Docstring#has_tag? # @see Docstring#has_tag?
# #
# source://yard//lib/yard/code_objects/base.rb#555 # source://yard//lib/yard/code_objects/base.rb#556
def has_tag?(name); end def has_tag?(name); end
# @return [Integer] the object's hash value (for equality checking) # @return [Integer] the object's hash value (for equality checking)
# #
# source://yard//lib/yard/code_objects/base.rb#333 # source://yard//lib/yard/code_objects/base.rb#334
def hash; end def hash; end
# Inspects the object, returning the type and path # Inspects the object, returning the type and path
# #
# @return [String] a string describing the object # @return [String] a string describing the object
# #
# source://yard//lib/yard/code_objects/base.rb#512 # source://yard//lib/yard/code_objects/base.rb#513
def inspect; end def inspect; end
# Returns the line the object was first parsed at (or nil) # Returns the line the object was first parsed at (or nil)
@ -2669,13 +2670,13 @@ class YARD::CodeObjects::Base
# @return [Fixnum] the line where the object was first defined. # @return [Fixnum] the line where the object was first defined.
# @return [nil] if there is no line associated with the object # @return [nil] if there is no line associated with the object
# #
# source://yard//lib/yard/code_objects/base.rb#314 # source://yard//lib/yard/code_objects/base.rb#315
def line; end def line; end
# @overload dynamic_attr_name # @overload dynamic_attr_name
# @overload dynamic_attr_name= # @overload dynamic_attr_name=
# #
# source://yard//lib/yard/code_objects/base.rb#372 # source://yard//lib/yard/code_objects/base.rb#373
def method_missing(meth, *args, &block); end def method_missing(meth, *args, &block); end
# The name of the object # The name of the object
@ -2703,7 +2704,7 @@ class YARD::CodeObjects::Base
# for {Registry.root}). If obj is nil, the object is unregistered # for {Registry.root}). If obj is nil, the object is unregistered
# from the Registry. # from the Registry.
# #
# source://yard//lib/yard/code_objects/base.rb#521 # source://yard//lib/yard/code_objects/base.rb#522
def namespace=(obj); end def namespace=(obj); end
# The namespace the object is defined in. If the object is in the # The namespace the object is defined in. If the object is in the
@ -2720,7 +2721,7 @@ class YARD::CodeObjects::Base
# for {Registry.root}). If obj is nil, the object is unregistered # for {Registry.root}). If obj is nil, the object is unregistered
# from the Registry. # from the Registry.
# #
# source://yard//lib/yard/code_objects/base.rb#521 # source://yard//lib/yard/code_objects/base.rb#522
def parent=(obj); end def parent=(obj); end
# Represents the unique path of the object. The default implementation # Represents the unique path of the object. The default implementation
@ -2733,19 +2734,19 @@ class YARD::CodeObjects::Base
# @return [String] the unique path of the object # @return [String] the unique path of the object
# @see #sep # @see #sep
# #
# source://yard//lib/yard/code_objects/base.rb#452 # source://yard//lib/yard/code_objects/base.rb#453
def path; end def path; end
# @param other [Base, String] another code object (or object path) # @param other [Base, String] another code object (or object path)
# @return [String] the shortest relative path from this object to +other+ # @return [String] the shortest relative path from this object to +other+
# @since 0.5.3 # @since 0.5.3
# #
# source://yard//lib/yard/code_objects/base.rb#474 # source://yard//lib/yard/code_objects/base.rb#475
def relative_path(other); end def relative_path(other); end
# @return [Boolean] whether or not this object is a RootObject # @return [Boolean] whether or not this object is a RootObject
# #
# source://yard//lib/yard/code_objects/base.rb#566 # source://yard//lib/yard/code_objects/base.rb#567
def root?; end def root?; end
# Override this method with a custom component separator. For instance, # Override this method with a custom component separator. For instance,
@ -2756,7 +2757,7 @@ class YARD::CodeObjects::Base
# @return [String] the component that separates the namespace path # @return [String] the component that separates the namespace path
# and the name (default is {NSEP}) # and the name (default is {NSEP})
# #
# source://yard//lib/yard/code_objects/base.rb#575 # source://yard//lib/yard/code_objects/base.rb#576
def sep; end def sep; end
# The one line signature representing an object. For a method, this will # The one line signature representing an object. For a method, this will
@ -2789,7 +2790,7 @@ class YARD::CodeObjects::Base
# @param statement [#source, String] the +Parser::Statement+ holding the source code or the raw source # @param statement [#source, String] the +Parser::Statement+ holding the source code or the raw source
# as a +String+ for the definition of the code object only (not the block) # as a +String+ for the definition of the code object only (not the block)
# #
# source://yard//lib/yard/code_objects/base.rb#387 # source://yard//lib/yard/code_objects/base.rb#388
def source=(statement); end def source=(statement); end
# Language of the source code associated with the object. Defaults to # Language of the source code associated with the object. Defaults to
@ -2812,14 +2813,14 @@ class YARD::CodeObjects::Base
# #
# @see Docstring#tag # @see Docstring#tag
# #
# source://yard//lib/yard/code_objects/base.rb#547 # source://yard//lib/yard/code_objects/base.rb#548
def tag(name); end def tag(name); end
# Gets a list of tags from the {#docstring} # Gets a list of tags from the {#docstring}
# #
# @see Docstring#tags # @see Docstring#tags
# #
# source://yard//lib/yard/code_objects/base.rb#551 # source://yard//lib/yard/code_objects/base.rb#552
def tags(name = T.unsafe(nil)); end def tags(name = T.unsafe(nil)); end
# @note Override this method if your object has a special title that does # @note Override this method if your object has a special title that does
@ -2828,12 +2829,12 @@ class YARD::CodeObjects::Base
# @return [String] the display title for an object # @return [String] the display title for an object
# @see 0.8.4 # @see 0.8.4
# #
# source://yard//lib/yard/code_objects/base.rb#467 # source://yard//lib/yard/code_objects/base.rb#468
def title; end def title; end
# @return [nil] this object does not turn into an array # @return [nil] this object does not turn into an array
# #
# source://yard//lib/yard/code_objects/base.rb#336 # source://yard//lib/yard/code_objects/base.rb#337
def to_ary; end def to_ary; end
# Represents the unique path of the object. The default implementation # Represents the unique path of the object. The default implementation
@ -2846,7 +2847,7 @@ class YARD::CodeObjects::Base
# @return [String] the unique path of the object # @return [String] the unique path of the object
# @see #sep # @see #sep
# #
# source://yard//lib/yard/code_objects/base.rb#452 # source://yard//lib/yard/code_objects/base.rb#453
def to_s; end def to_s; end
# Default type is the lowercase class name without the "Object" suffix. # Default type is the lowercase class name without the "Object" suffix.
@ -2854,7 +2855,7 @@ class YARD::CodeObjects::Base
# #
# @return [Symbol] the type of code object this represents # @return [Symbol] the type of code object this represents
# #
# source://yard//lib/yard/code_objects/base.rb#436 # source://yard//lib/yard/code_objects/base.rb#437
def type; end def type; end
# @return [Symbol] the visibility of an object (:public, :private, :protected) # @return [Symbol] the visibility of an object (:public, :private, :protected)
@ -2877,7 +2878,7 @@ class YARD::CodeObjects::Base
# @see #copy_to # @see #copy_to
# @since 0.8.0 # @since 0.8.0
# #
# source://yard//lib/yard/code_objects/base.rb#586 # source://yard//lib/yard/code_objects/base.rb#587
def copyable_attributes; end def copyable_attributes; end
private private
@ -2887,10 +2888,10 @@ class YARD::CodeObjects::Base
# @param source [String] the source code to format # @param source [String] the source code to format
# @return [String] formatted source # @return [String] formatted source
# #
# source://yard//lib/yard/code_objects/base.rb#598 # source://yard//lib/yard/code_objects/base.rb#599
def format_source(source); end def format_source(source); end
# source://yard//lib/yard/code_objects/base.rb#605 # source://yard//lib/yard/code_objects/base.rb#606
def translate_docstring(locale); end def translate_docstring(locale); end
class << self class << self
@ -11033,10 +11034,10 @@ class YARD::Parser::SourceParser
# @since 0.5.6 # @since 0.5.6
# #
# source://yard//lib/yard/parser/source_parser.rb#516 # source://yard//lib/yard/parser/source_parser.rb#515
def parser_class; end def parser_class; end
# source://yard//lib/yard/parser/source_parser.rb#501 # source://yard//lib/yard/parser/source_parser.rb#500
def parser_type=(value); end def parser_type=(value); end
# Guesses the parser type to use depending on the file extension. # Guesses the parser type to use depending on the file extension.
@ -11044,14 +11045,14 @@ class YARD::Parser::SourceParser
# @param filename [String] the filename to use to guess the parser type # @param filename [String] the filename to use to guess the parser type
# @return [Symbol] a parser type that matches the filename # @return [Symbol] a parser type that matches the filename
# #
# source://yard//lib/yard/parser/source_parser.rb#509 # source://yard//lib/yard/parser/source_parser.rb#508
def parser_type_for_filename(filename); end def parser_type_for_filename(filename); end
# Runs a {Handlers::Processor} object to post process the parsed statements. # Runs a {Handlers::Processor} object to post process the parsed statements.
# #
# @return [void] # @return [void]
# #
# source://yard//lib/yard/parser/source_parser.rb#491 # source://yard//lib/yard/parser/source_parser.rb#490
def post_process; end def post_process; end
class << self class << self