rbs 3.7.0 → 3.8.0.pre.1

data/stdlib/zlib/0/gzip_file/crc_error.rbs

@@ -1,109 +1,6 @@
-# <!-- rdoc-file=ext/zlib/zlib.c -->
-# This module provides access to the [zlib library](http://zlib.net). Zlib is
-# designed to be a portable, free, general-purpose, legally unencumbered -- that
-# is, not covered by any patents -- lossless data-compression library for use on
-# virtually any computer hardware and operating system.
-#
-# The zlib compression library provides in-memory compression and decompression
-# functions, including integrity checks of the uncompressed data.
-#
-# The zlib compressed data format is described in RFC 1950, which is a wrapper
-# around a deflate stream which is described in RFC 1951.
-#
-# The library also supports reading and writing files in gzip (.gz) format with
-# an interface similar to that of IO. The gzip format is described in RFC 1952
-# which is also a wrapper around a deflate stream.
-#
-# The zlib format was designed to be compact and fast for use in memory and on
-# communications channels. The gzip format was designed for single-file
-# compression on file systems, has a larger header than zlib to maintain
-# directory information, and uses a different, slower check method than zlib.
-#
-# See your system's zlib.h for further information about zlib
-#
-# ## Sample usage
-#
-# Using the wrapper to compress strings with default parameters is quite simple:
-#
-#     require "zlib"
-#
-#     data_to_compress = File.read("don_quixote.txt")
-#
-#     puts "Input size: #{data_to_compress.size}"
-#     #=> Input size: 2347740
-#
-#     data_compressed = Zlib::Deflate.deflate(data_to_compress)
-#
-#     puts "Compressed size: #{data_compressed.size}"
-#     #=> Compressed size: 887238
-#
-#     uncompressed_data = Zlib::Inflate.inflate(data_compressed)
-#
-#     puts "Uncompressed data is: #{uncompressed_data}"
-#     #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
-#
-# ## Class tree
-#
-# *   Zlib::Deflate
-# *   Zlib::Inflate
-# *   Zlib::ZStream
-# *   Zlib::Error
-#     *   Zlib::StreamEnd
-#     *   Zlib::NeedDict
-#     *   Zlib::DataError
-#     *   Zlib::StreamError
-#     *   Zlib::MemError
-#     *   Zlib::BufError
-#     *   Zlib::VersionError
-#     *   Zlib::InProgressError
-#
-#
-#
-# (if you have GZIP_SUPPORT)
-# *   Zlib::GzipReader
-# *   Zlib::GzipWriter
-# *   Zlib::GzipFile
-# *   Zlib::GzipFile::Error
-#     *   Zlib::GzipFile::LengthError
-#     *   Zlib::GzipFile::CRCError
-#     *   Zlib::GzipFile::NoFooter
-#
+%a{annotate:rdoc:skip}
 module Zlib
-  # <!-- rdoc-file=ext/zlib/zlib.c -->
-  # Zlib::GzipFile is an abstract class for handling a gzip formatted compressed
-  # file. The operations are defined in the subclasses, Zlib::GzipReader for
-  # reading, and Zlib::GzipWriter for writing.
-  #
-  # GzipReader should be used by associating an IO, or IO-like, object.
-  #
-  # ## Method Catalogue
-  #
-  # *   ::wrap
-  # *   ::open (Zlib::GzipReader::open and Zlib::GzipWriter::open)
-  # *   #close
-  # *   #closed?
-  # *   #comment
-  # *   comment= (Zlib::GzipWriter#comment=)
-  # *   #crc
-  # *   eof? (Zlib::GzipReader#eof?)
-  # *   #finish
-  # *   #level
-  # *   lineno (Zlib::GzipReader#lineno)
-  # *   lineno= (Zlib::GzipReader#lineno=)
-  # *   #mtime
-  # *   mtime= (Zlib::GzipWriter#mtime=)
-  # *   #orig_name
-  # *   orig_name (Zlib::GzipWriter#orig_name=)
-  # *   #os_code
-  # *   path (when the underlying IO supports #path)
-  # *   #sync
-  # *   #sync=
-  # *   #to_io
-  #
-  #
-  # (due to internal structure, documentation may appear under Zlib::GzipReader or
-  # Zlib::GzipWriter)
-  #
+  %a{annotate:rdoc:skip}
   class GzipFile
     # <!-- rdoc-file=ext/zlib/zlib.c -->
     # Raised when the CRC checksum recorded in gzip file footer is not equivalent to

data/stdlib/zlib/0/gzip_file/error.rbs

@@ -1,109 +1,6 @@
-# <!-- rdoc-file=ext/zlib/zlib.c -->
-# This module provides access to the [zlib library](http://zlib.net). Zlib is
-# designed to be a portable, free, general-purpose, legally unencumbered -- that
-# is, not covered by any patents -- lossless data-compression library for use on
-# virtually any computer hardware and operating system.
-#
-# The zlib compression library provides in-memory compression and decompression
-# functions, including integrity checks of the uncompressed data.
-#
-# The zlib compressed data format is described in RFC 1950, which is a wrapper
-# around a deflate stream which is described in RFC 1951.
-#
-# The library also supports reading and writing files in gzip (.gz) format with
-# an interface similar to that of IO. The gzip format is described in RFC 1952
-# which is also a wrapper around a deflate stream.
-#
-# The zlib format was designed to be compact and fast for use in memory and on
-# communications channels. The gzip format was designed for single-file
-# compression on file systems, has a larger header than zlib to maintain
-# directory information, and uses a different, slower check method than zlib.
-#
-# See your system's zlib.h for further information about zlib
-#
-# ## Sample usage
-#
-# Using the wrapper to compress strings with default parameters is quite simple:
-#
-#     require "zlib"
-#
-#     data_to_compress = File.read("don_quixote.txt")
-#
-#     puts "Input size: #{data_to_compress.size}"
-#     #=> Input size: 2347740
-#
-#     data_compressed = Zlib::Deflate.deflate(data_to_compress)
-#
-#     puts "Compressed size: #{data_compressed.size}"
-#     #=> Compressed size: 887238
-#
-#     uncompressed_data = Zlib::Inflate.inflate(data_compressed)
-#
-#     puts "Uncompressed data is: #{uncompressed_data}"
-#     #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
-#
-# ## Class tree
-#
-# *   Zlib::Deflate
-# *   Zlib::Inflate
-# *   Zlib::ZStream
-# *   Zlib::Error
-#     *   Zlib::StreamEnd
-#     *   Zlib::NeedDict
-#     *   Zlib::DataError
-#     *   Zlib::StreamError
-#     *   Zlib::MemError
-#     *   Zlib::BufError
-#     *   Zlib::VersionError
-#     *   Zlib::InProgressError
-#
-#
-#
-# (if you have GZIP_SUPPORT)
-# *   Zlib::GzipReader
-# *   Zlib::GzipWriter
-# *   Zlib::GzipFile
-# *   Zlib::GzipFile::Error
-#     *   Zlib::GzipFile::LengthError
-#     *   Zlib::GzipFile::CRCError
-#     *   Zlib::GzipFile::NoFooter
-#
+%a{annotate:rdoc:skip}
 module Zlib
-  # <!-- rdoc-file=ext/zlib/zlib.c -->
-  # Zlib::GzipFile is an abstract class for handling a gzip formatted compressed
-  # file. The operations are defined in the subclasses, Zlib::GzipReader for
-  # reading, and Zlib::GzipWriter for writing.
-  #
-  # GzipReader should be used by associating an IO, or IO-like, object.
-  #
-  # ## Method Catalogue
-  #
-  # *   ::wrap
-  # *   ::open (Zlib::GzipReader::open and Zlib::GzipWriter::open)
-  # *   #close
-  # *   #closed?
-  # *   #comment
-  # *   comment= (Zlib::GzipWriter#comment=)
-  # *   #crc
-  # *   eof? (Zlib::GzipReader#eof?)
-  # *   #finish
-  # *   #level
-  # *   lineno (Zlib::GzipReader#lineno)
-  # *   lineno= (Zlib::GzipReader#lineno=)
-  # *   #mtime
-  # *   mtime= (Zlib::GzipWriter#mtime=)
-  # *   #orig_name
-  # *   orig_name (Zlib::GzipWriter#orig_name=)
-  # *   #os_code
-  # *   path (when the underlying IO supports #path)
-  # *   #sync
-  # *   #sync=
-  # *   #to_io
-  #
-  #
-  # (due to internal structure, documentation may appear under Zlib::GzipReader or
-  # Zlib::GzipWriter)
-  #
+  %a{annotate:rdoc:skip}
   class GzipFile
     # <!-- rdoc-file=ext/zlib/zlib.c -->
     # Base class of errors that occur when processing GZIP files.

data/stdlib/zlib/0/gzip_file/length_error.rbs

@@ -1,109 +1,6 @@
-# <!-- rdoc-file=ext/zlib/zlib.c -->
-# This module provides access to the [zlib library](http://zlib.net). Zlib is
-# designed to be a portable, free, general-purpose, legally unencumbered -- that
-# is, not covered by any patents -- lossless data-compression library for use on
-# virtually any computer hardware and operating system.
-#
-# The zlib compression library provides in-memory compression and decompression
-# functions, including integrity checks of the uncompressed data.
-#
-# The zlib compressed data format is described in RFC 1950, which is a wrapper
-# around a deflate stream which is described in RFC 1951.
-#
-# The library also supports reading and writing files in gzip (.gz) format with
-# an interface similar to that of IO. The gzip format is described in RFC 1952
-# which is also a wrapper around a deflate stream.
-#
-# The zlib format was designed to be compact and fast for use in memory and on
-# communications channels. The gzip format was designed for single-file
-# compression on file systems, has a larger header than zlib to maintain
-# directory information, and uses a different, slower check method than zlib.
-#
-# See your system's zlib.h for further information about zlib
-#
-# ## Sample usage
-#
-# Using the wrapper to compress strings with default parameters is quite simple:
-#
-#     require "zlib"
-#
-#     data_to_compress = File.read("don_quixote.txt")
-#
-#     puts "Input size: #{data_to_compress.size}"
-#     #=> Input size: 2347740
-#
-#     data_compressed = Zlib::Deflate.deflate(data_to_compress)
-#
-#     puts "Compressed size: #{data_compressed.size}"
-#     #=> Compressed size: 887238
-#
-#     uncompressed_data = Zlib::Inflate.inflate(data_compressed)
-#
-#     puts "Uncompressed data is: #{uncompressed_data}"
-#     #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
-#
-# ## Class tree
-#
-# *   Zlib::Deflate
-# *   Zlib::Inflate
-# *   Zlib::ZStream
-# *   Zlib::Error
-#     *   Zlib::StreamEnd
-#     *   Zlib::NeedDict
-#     *   Zlib::DataError
-#     *   Zlib::StreamError
-#     *   Zlib::MemError
-#     *   Zlib::BufError
-#     *   Zlib::VersionError
-#     *   Zlib::InProgressError
-#
-#
-#
-# (if you have GZIP_SUPPORT)
-# *   Zlib::GzipReader
-# *   Zlib::GzipWriter
-# *   Zlib::GzipFile
-# *   Zlib::GzipFile::Error
-#     *   Zlib::GzipFile::LengthError
-#     *   Zlib::GzipFile::CRCError
-#     *   Zlib::GzipFile::NoFooter
-#
+%a{annotate:rdoc:skip}
 module Zlib
-  # <!-- rdoc-file=ext/zlib/zlib.c -->
-  # Zlib::GzipFile is an abstract class for handling a gzip formatted compressed
-  # file. The operations are defined in the subclasses, Zlib::GzipReader for
-  # reading, and Zlib::GzipWriter for writing.
-  #
-  # GzipReader should be used by associating an IO, or IO-like, object.
-  #
-  # ## Method Catalogue
-  #
-  # *   ::wrap
-  # *   ::open (Zlib::GzipReader::open and Zlib::GzipWriter::open)
-  # *   #close
-  # *   #closed?
-  # *   #comment
-  # *   comment= (Zlib::GzipWriter#comment=)
-  # *   #crc
-  # *   eof? (Zlib::GzipReader#eof?)
-  # *   #finish
-  # *   #level
-  # *   lineno (Zlib::GzipReader#lineno)
-  # *   lineno= (Zlib::GzipReader#lineno=)
-  # *   #mtime
-  # *   mtime= (Zlib::GzipWriter#mtime=)
-  # *   #orig_name
-  # *   orig_name (Zlib::GzipWriter#orig_name=)
-  # *   #os_code
-  # *   path (when the underlying IO supports #path)
-  # *   #sync
-  # *   #sync=
-  # *   #to_io
-  #
-  #
-  # (due to internal structure, documentation may appear under Zlib::GzipReader or
-  # Zlib::GzipWriter)
-  #
+  %a{annotate:rdoc:skip}
   class GzipFile
     # <!-- rdoc-file=ext/zlib/zlib.c -->
     # Raised when the data length recorded in the gzip file footer is not equivalent

data/stdlib/zlib/0/gzip_file/no_footer.rbs

@@ -1,109 +1,6 @@
-# <!-- rdoc-file=ext/zlib/zlib.c -->
-# This module provides access to the [zlib library](http://zlib.net). Zlib is
-# designed to be a portable, free, general-purpose, legally unencumbered -- that
-# is, not covered by any patents -- lossless data-compression library for use on
-# virtually any computer hardware and operating system.
-#
-# The zlib compression library provides in-memory compression and decompression
-# functions, including integrity checks of the uncompressed data.
-#
-# The zlib compressed data format is described in RFC 1950, which is a wrapper
-# around a deflate stream which is described in RFC 1951.
-#
-# The library also supports reading and writing files in gzip (.gz) format with
-# an interface similar to that of IO. The gzip format is described in RFC 1952
-# which is also a wrapper around a deflate stream.
-#
-# The zlib format was designed to be compact and fast for use in memory and on
-# communications channels. The gzip format was designed for single-file
-# compression on file systems, has a larger header than zlib to maintain
-# directory information, and uses a different, slower check method than zlib.
-#
-# See your system's zlib.h for further information about zlib
-#
-# ## Sample usage
-#
-# Using the wrapper to compress strings with default parameters is quite simple:
-#
-#     require "zlib"
-#
-#     data_to_compress = File.read("don_quixote.txt")
-#
-#     puts "Input size: #{data_to_compress.size}"
-#     #=> Input size: 2347740
-#
-#     data_compressed = Zlib::Deflate.deflate(data_to_compress)
-#
-#     puts "Compressed size: #{data_compressed.size}"
-#     #=> Compressed size: 887238
-#
-#     uncompressed_data = Zlib::Inflate.inflate(data_compressed)
-#
-#     puts "Uncompressed data is: #{uncompressed_data}"
-#     #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
-#
-# ## Class tree
-#
-# *   Zlib::Deflate
-# *   Zlib::Inflate
-# *   Zlib::ZStream
-# *   Zlib::Error
-#     *   Zlib::StreamEnd
-#     *   Zlib::NeedDict
-#     *   Zlib::DataError
-#     *   Zlib::StreamError
-#     *   Zlib::MemError
-#     *   Zlib::BufError
-#     *   Zlib::VersionError
-#     *   Zlib::InProgressError
-#
-#
-#
-# (if you have GZIP_SUPPORT)
-# *   Zlib::GzipReader
-# *   Zlib::GzipWriter
-# *   Zlib::GzipFile
-# *   Zlib::GzipFile::Error
-#     *   Zlib::GzipFile::LengthError
-#     *   Zlib::GzipFile::CRCError
-#     *   Zlib::GzipFile::NoFooter
-#
+%a{annotate:rdoc:skip}
 module Zlib
-  # <!-- rdoc-file=ext/zlib/zlib.c -->
-  # Zlib::GzipFile is an abstract class for handling a gzip formatted compressed
-  # file. The operations are defined in the subclasses, Zlib::GzipReader for
-  # reading, and Zlib::GzipWriter for writing.
-  #
-  # GzipReader should be used by associating an IO, or IO-like, object.
-  #
-  # ## Method Catalogue
-  #
-  # *   ::wrap
-  # *   ::open (Zlib::GzipReader::open and Zlib::GzipWriter::open)
-  # *   #close
-  # *   #closed?
-  # *   #comment
-  # *   comment= (Zlib::GzipWriter#comment=)
-  # *   #crc
-  # *   eof? (Zlib::GzipReader#eof?)
-  # *   #finish
-  # *   #level
-  # *   lineno (Zlib::GzipReader#lineno)
-  # *   lineno= (Zlib::GzipReader#lineno=)
-  # *   #mtime
-  # *   mtime= (Zlib::GzipWriter#mtime=)
-  # *   #orig_name
-  # *   orig_name (Zlib::GzipWriter#orig_name=)
-  # *   #os_code
-  # *   path (when the underlying IO supports #path)
-  # *   #sync
-  # *   #sync=
-  # *   #to_io
-  #
-  #
-  # (due to internal structure, documentation may appear under Zlib::GzipReader or
-  # Zlib::GzipWriter)
-  #
+  %a{annotate:rdoc:skip}
   class GzipFile
     # <!-- rdoc-file=ext/zlib/zlib.c -->
     # Raised when gzip file footer is not found.

data/stdlib/zlib/0/gzip_file.rbs

@@ -1,73 +1,4 @@
-# <!-- rdoc-file=ext/zlib/zlib.c -->
-# This module provides access to the [zlib library](http://zlib.net). Zlib is
-# designed to be a portable, free, general-purpose, legally unencumbered -- that
-# is, not covered by any patents -- lossless data-compression library for use on
-# virtually any computer hardware and operating system.
-#
-# The zlib compression library provides in-memory compression and decompression
-# functions, including integrity checks of the uncompressed data.
-#
-# The zlib compressed data format is described in RFC 1950, which is a wrapper
-# around a deflate stream which is described in RFC 1951.
-#
-# The library also supports reading and writing files in gzip (.gz) format with
-# an interface similar to that of IO. The gzip format is described in RFC 1952
-# which is also a wrapper around a deflate stream.
-#
-# The zlib format was designed to be compact and fast for use in memory and on
-# communications channels. The gzip format was designed for single-file
-# compression on file systems, has a larger header than zlib to maintain
-# directory information, and uses a different, slower check method than zlib.
-#
-# See your system's zlib.h for further information about zlib
-#
-# ## Sample usage
-#
-# Using the wrapper to compress strings with default parameters is quite simple:
-#
-#     require "zlib"
-#
-#     data_to_compress = File.read("don_quixote.txt")
-#
-#     puts "Input size: #{data_to_compress.size}"
-#     #=> Input size: 2347740
-#
-#     data_compressed = Zlib::Deflate.deflate(data_to_compress)
-#
-#     puts "Compressed size: #{data_compressed.size}"
-#     #=> Compressed size: 887238
-#
-#     uncompressed_data = Zlib::Inflate.inflate(data_compressed)
-#
-#     puts "Uncompressed data is: #{uncompressed_data}"
-#     #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
-#
-# ## Class tree
-#
-# *   Zlib::Deflate
-# *   Zlib::Inflate
-# *   Zlib::ZStream
-# *   Zlib::Error
-#     *   Zlib::StreamEnd
-#     *   Zlib::NeedDict
-#     *   Zlib::DataError
-#     *   Zlib::StreamError
-#     *   Zlib::MemError
-#     *   Zlib::BufError
-#     *   Zlib::VersionError
-#     *   Zlib::InProgressError
-#
-#
-#
-# (if you have GZIP_SUPPORT)
-# *   Zlib::GzipReader
-# *   Zlib::GzipWriter
-# *   Zlib::GzipFile
-# *   Zlib::GzipFile::Error
-#     *   Zlib::GzipFile::LengthError
-#     *   Zlib::GzipFile::CRCError
-#     *   Zlib::GzipFile::NoFooter
-#
+%a{annotate:rdoc:skip}
 module Zlib
   # <!-- rdoc-file=ext/zlib/zlib.c -->
   # Zlib::GzipFile is an abstract class for handling a gzip formatted compressed
@@ -100,7 +31,6 @@ module Zlib
   # *   #sync=
   # *   #to_io
   #
-  #
   # (due to internal structure, documentation may appear under Zlib::GzipReader or
   # Zlib::GzipWriter)
   #

data/stdlib/zlib/0/gzip_reader.rbs

@@ -1,73 +1,4 @@
-# <!-- rdoc-file=ext/zlib/zlib.c -->
-# This module provides access to the [zlib library](http://zlib.net). Zlib is
-# designed to be a portable, free, general-purpose, legally unencumbered -- that
-# is, not covered by any patents -- lossless data-compression library for use on
-# virtually any computer hardware and operating system.
-#
-# The zlib compression library provides in-memory compression and decompression
-# functions, including integrity checks of the uncompressed data.
-#
-# The zlib compressed data format is described in RFC 1950, which is a wrapper
-# around a deflate stream which is described in RFC 1951.
-#
-# The library also supports reading and writing files in gzip (.gz) format with
-# an interface similar to that of IO. The gzip format is described in RFC 1952
-# which is also a wrapper around a deflate stream.
-#
-# The zlib format was designed to be compact and fast for use in memory and on
-# communications channels. The gzip format was designed for single-file
-# compression on file systems, has a larger header than zlib to maintain
-# directory information, and uses a different, slower check method than zlib.
-#
-# See your system's zlib.h for further information about zlib
-#
-# ## Sample usage
-#
-# Using the wrapper to compress strings with default parameters is quite simple:
-#
-#     require "zlib"
-#
-#     data_to_compress = File.read("don_quixote.txt")
-#
-#     puts "Input size: #{data_to_compress.size}"
-#     #=> Input size: 2347740
-#
-#     data_compressed = Zlib::Deflate.deflate(data_to_compress)
-#
-#     puts "Compressed size: #{data_compressed.size}"
-#     #=> Compressed size: 887238
-#
-#     uncompressed_data = Zlib::Inflate.inflate(data_compressed)
-#
-#     puts "Uncompressed data is: #{uncompressed_data}"
-#     #=> Uncompressed data is: The Project Gutenberg EBook of Don Quixote...
-#
-# ## Class tree
-#
-# *   Zlib::Deflate
-# *   Zlib::Inflate
-# *   Zlib::ZStream
-# *   Zlib::Error
-#     *   Zlib::StreamEnd
-#     *   Zlib::NeedDict
-#     *   Zlib::DataError
-#     *   Zlib::StreamError
-#     *   Zlib::MemError
-#     *   Zlib::BufError
-#     *   Zlib::VersionError
-#     *   Zlib::InProgressError
-#
-#
-#
-# (if you have GZIP_SUPPORT)
-# *   Zlib::GzipReader
-# *   Zlib::GzipWriter
-# *   Zlib::GzipFile
-# *   Zlib::GzipFile::Error
-#     *   Zlib::GzipFile::LengthError
-#     *   Zlib::GzipFile::CRCError
-#     *   Zlib::GzipFile::NoFooter
-#
+%a{annotate:rdoc:skip}
 module Zlib
   # <!-- rdoc-file=ext/zlib/zlib.c -->
   # Zlib::GzipReader is the class for reading a gzipped file.  GzipReader should
@@ -101,7 +32,6 @@ module Zlib
   # *   #readlines
   # *   #ungetc
   #
-  #
   # Be careful of the footer of the gzip file. A gzip file has the checksum of
   # pre-compressed data in its footer. GzipReader checks all uncompressed data
   # against that checksum at the following cases, and if it fails, raises
@@ -116,7 +46,6 @@ module Zlib
   # *   When Zlib::GzipReader#unused method is called after the object reaches the
   #     end of file.
   #
-  #
   # The rest of the methods are adequately described in their own documentation.
   #
   class GzipReader < Zlib::GzipFile
@@ -254,7 +183,7 @@ module Zlib
 
     # <!--
     #   rdoc-file=ext/zlib/zlib.c
-    #   - read(p1 = v1)
+    #   - read(p1 = v1, p2 = v2)
     # -->
     # See Zlib::GzipReader documentation for a description.
     #
@@ -296,7 +225,7 @@ module Zlib
     #   rdoc-file=ext/zlib/zlib.c
     #   - gzipreader.readpartial(maxlen [, outbuf]) => string, outbuf
     # -->
-    # Reads at most *maxlen* bytes from the gziped stream but it blocks only if
+    # Reads at most *maxlen* bytes from the gzipped stream but it blocks only if
     # *gzipreader* has no data immediately available. If the optional *outbuf*
     # argument is present, it must reference a String, which will receive the data.
     # It raises `EOFError` on end of file.