stdlib/uri/0/common.rbs in rbs-2.0.0 vs stdlib/uri/0/common.rbs in rbs-2.1.0

@@ -1,5 +1,6 @@
+# <!-- rdoc-file=lib/uri.rb -->
 # URI is a module providing classes to handle Uniform Resource Identifiers
 # ([RFC2396](http://tools.ietf.org/html/rfc2396)).
 #
 # ## Features
 #
@@ -28,11 +29,11 @@
 #
 #     module URI
 #       class RSYNC < Generic
 #         DEFAULT_PORT = 873
 #       end
-#       @@schemes['RSYNC'] = RSYNC
+#       register_scheme 'RSYNC', RSYNC
 #     end
 #     #=> URI::RSYNC
 #
 #     URI.scheme_list
 #     #=> {"FILE"=>URI::File, "FTP"=>URI::FTP, "HTTP"=>URI::HTTP,
@@ -73,11 +74,10 @@
 # *   URI::Parser - (in uri/common.rb)
 # *   URI::REGEXP - (in uri/common.rb)
 #     *   URI::REGEXP::PATTERN - (in uri/common.rb)
 #
 # *   URI::Util - (in uri/common.rb)
-# *   URI::Escape - (in uri/common.rb)
 # *   URI::Error - (in uri/common.rb)
 #     *   URI::InvalidURIError - (in uri/common.rb)
 #     *   URI::InvalidComponentError - (in uri/common.rb)
 #     *   URI::BadURIError - (in uri/common.rb)
 #
@@ -91,16 +91,18 @@
 # :   Akira Yamada <[e-mail]> Dmitry V. Sabanin <[e-mail]>
 #     Vincent Batts <[e-mail]>
 # License
 # :   Copyright (c) 2001 akira yamada <[e-mail]> You can redistribute
 #     it and/or modify it under the same term as Ruby.
-# Revision
-# :   $Id$
 #
 module URI
   include URI::RFC2396_REGEXP
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - decode_www_form(str, enc=Encoding::UTF_8, separator: '&', use__charset_: false, isindex: false)
+  # -->
   # Decodes URL-encoded form data from given `str`.
   #
   # This decodes application/x-www-form-urlencoded data and returns an array of
   # key-value arrays.
   #
@@ -116,18 +118,26 @@
   #
   # See URI.decode_www_form_component, URI.encode_www_form.
   #
   def self.decode_www_form: (String str, ?encoding enc, ?isindex: boolish, ?use__charset_: boolish, ?separator: String) -> Array[[ String, String ]]
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - decode_www_form_component(str, enc=Encoding::UTF_8)
+  # -->
   # Decodes given `str` of URL-encoded form data.
   #
   # This decodes + to SP.
   #
   # See URI.encode_www_form_component, URI.decode_www_form.
   #
   def self.decode_www_form_component: (String str, ?encoding enc) -> String
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - encode_www_form(enum, enc=nil)
+  # -->
   # Generates URL-encoded form data from given `enum`.
   #
   # This generates application/x-www-form-urlencoded data defined in HTML5 from
   # given an Enumerable object.
   #
@@ -139,11 +149,11 @@
   # incompatible encoding are converted to UTF-8.)
   #
   # This method doesn't handle files.  When you send a file, use
   # multipart/form-data.
   #
-  # This refers http://url.spec.whatwg.org/#concept-urlencoded-serializer
+  # This refers https://url.spec.whatwg.org/#concept-urlencoded-serializer
   #
   #     URI.encode_www_form([["q", "ruby"], ["lang", "en"]])
   #     #=> "q=ruby&lang=en"
   #     URI.encode_www_form("q" => "ruby", "lang" => "en")
   #     #=> "q=ruby&lang=en"
@@ -154,24 +164,32 @@
   #
   # See URI.encode_www_form_component, URI.decode_www_form.
   #
   def self.encode_www_form: (Enumerable[[ _ToS, _ToS ]] enum, ?encoding? enc) -> String
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - encode_www_form_component(str, enc=nil)
+  # -->
   # Encodes given `str` to URL-encoded form data.
   #
   # This method doesn't convert *, -, ., 0-9, A-Z, _, a-z, but does convert SP
   # (ASCII space) to + and converts others to %XX.
   #
   # If `enc` is given, convert `str` to the encoding before percent encoding.
   #
   # This is an implementation of
-  # http://www.w3.org/TR/2013/CR-html5-20130806/forms.html#url-encoded-form-data.
+  # https://www.w3.org/TR/2013/CR-html5-20130806/forms.html#url-encoded-form-data.
   #
   # See URI.decode_www_form_component, URI.encode_www_form.
   #
   def self.encode_www_form_component: (_ToS str, ?encoding? enc) -> String
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - extract(str, schemes = nil, &block)
+  # -->
   # ## Synopsis
   #
   #     URI::extract(str[, schemes][,&blk])
   #
   # ## Args
@@ -197,10 +215,14 @@
   def self.extract: (String str, ?Array[String] schemes) -> Array[String]
                   | (String str, ?Array[String] schemes) { (String) -> void } -> nil
 
   def self.get_encoding: (String label) -> Encoding?
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - join(*str)
+  # -->
   # ## Synopsis
   #
   #     URI::join(str[, str, ...])
   #
   # ## Args
@@ -232,10 +254,14 @@
   #     URI.join('http://example.com', '/foo/', 'bar')
   #     # => #<URI::HTTP http://example.com/foo/bar>
   #
   def self.join: (String str, *String strs) -> URI::Generic
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - parse(uri)
+  # -->
   # ## Synopsis
   #
   #     URI::parse(uri_str)
   #
   # ## Args
@@ -268,10 +294,14 @@
   # It's recommended to first ::escape the provided `uri_str` if there are any
   # invalid URI characters.
   #
   def self.parse: (_ToStr uri) -> (File | FTP | HTTP | HTTPS | LDAP | LDAPS | MailTo | WS | WSS | Generic)
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - regexp(schemes = nil)
+  # -->
   # ## Synopsis
   #
   #     URI::regexp([match_schemes])
   #
   # ## Args
@@ -283,11 +313,11 @@
   #
   # ## Description
   #
   # Returns a Regexp object which matches to URI-like strings. The Regexp object
   # returned by this method includes arbitrary number of capture group
-  # (parentheses).  Never rely on it's number.
+  # (parentheses).  Never rely on its number.
   #
   # ## Usage
   #
   #     require 'uri'
   #
@@ -302,19 +332,31 @@
   #       p $&
   #     end
   #
   def self.regexp: (?Array[String]? schemes) -> Regexp
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - scheme_list()
+  # -->
   # Returns a Hash of the defined schemes.
   #
   def self.scheme_list: () -> Hash[String, Class]
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - for(scheme, *arguments, default: Generic)
+  # -->
   # Construct a URI instance, using the scheme to detect the appropriate class
-  # from +URI.scheme_list+.
+  # from `URI.scheme_list`.
   #
   def self.for: (String scheme, *untyped arguments, ?default: Class) -> (File | FTP | HTTP | HTTPS | LDAP | LDAPS | MailTo | WS | WSS | Generic)
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - split(uri)
+  # -->
   # ## Synopsis
   #
   #     URI::split(uri)
   #
   # ## Args
@@ -352,11 +394,13 @@
 
 URI::ABS_URI: Regexp
 
 URI::ABS_URI_REF: Regexp
 
+# <!-- rdoc-file=lib/uri/common.rb -->
 # URI::Parser.new
+#
 URI::DEFAULT_PARSER: URI::RFC2396_Parser
 
 URI::ESCAPED: Regexp
 
 URI::FRAGMENT: Regexp
@@ -395,12 +439,17 @@
 
 URI::VERSION_CODE: String
 
 URI::WEB_ENCODINGS_: Hash[String, String]
 
+%a{annotate:rdoc:skip}
 module Kernel
   private
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - URI(uri)
+  # -->
   # Returns `uri` converted to an URI object.
   #
   def self?.URI: (URI::Generic | String uri) -> URI::Generic
 end