Dedup zlib docs

Author: soutaro

stdlib/zlib/0/buf_error.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 -->
   # Subclass of Zlib::Error when zlib returns a Z_BUF_ERROR.

stdlib/zlib/0/data_error.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 -->
   # Subclass of Zlib::Error when zlib returns a Z_DATA_ERROR.

stdlib/zlib/0/deflate.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::Deflate is the class for compressing data.  See Zlib::ZStream for more
@@ -126,10 +57,13 @@ module Zlib
     #
     # Zlib::NO_FLUSH
     # :   The default
+    #
     # Zlib::SYNC_FLUSH
     # :   Flushes the output to a byte boundary
+    #
     # Zlib::FULL_FLUSH
     # :   SYNC_FLUSH + resets the compression state
+    #
     # Zlib::FINISH
     # :   Pending input is processed, pending output is flushed.
     #
@@ -198,7 +132,6 @@ module Zlib
     # *   Zlib::BEST_SPEED
     # *   Zlib::BEST_COMPRESSION
     #
-    #
     # See http://www.zlib.net/manual.html#Constants for further information.
     #
     # The `window_bits` sets the size of the history buffer and should be between 8
@@ -213,18 +146,21 @@ module Zlib
     # *   Zlib::DEF_MEM_LEVEL
     # *   Zlib::MAX_MEM_LEVEL
     #
-    #
     # The `strategy` sets the deflate compression strategy.  The following
     # strategies are available:
     #
     # Zlib::DEFAULT_STRATEGY
     # :   For normal data
+    #
     # Zlib::FILTERED
     # :   For data produced by a filter or predictor
+    #
     # Zlib::FIXED
     # :   Prevents dynamic Huffman codes
+    #
     # Zlib::HUFFMAN_ONLY
     # :   Prevents string matching
+    #
     # Zlib::RLE
     # :   Designed for better compression of PNG image data
     #

stdlib/zlib/0/error.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 -->
   # The superclass for all exceptions raised by Ruby/zlib.