From: Eric Hodel <drbrain@...7.net>
Date: 2011-05-15T03:41:12+09:00
Subject: [ruby-core:36191] [Ruby 1.9 - Bug #4695] documentation updates: Zlib is 100%


Issue #4695 has been updated by Eric Hodel.


Applied with both typos fixed.

I also documented GZError#input which was set via gzfile_raise()
----------------------------------------
Bug #4695: documentation updates: Zlib is 100%
http://redmine.ruby-lang.org/issues/4695

Author: Vincent Batts
Status: Closed
Priority: Normal
Assignee: Eric Hodel
Category: DOC
Target version: 1.9.3
ruby -v: ruby 1.9.3dev (2011-05-14 trunk 31562) [i686-linux]


per http://blog.segment7.net/2011/05/09/ruby-1-9-3-documentation-challenge

A bit of this is cleanup of existing documentation.
This patch includes the following bits.

module Zlib # is documented

  # in file ext/zlib/zlib.c
  VERSION = nil
  # in file ext/zlib/zlib.c
  ZLIB_VERSION = nil
  # in file ext/zlib/zlib.c
  BINARY = nil
  # in file ext/zlib/zlib.c
  ASCII = nil
  # in file ext/zlib/zlib.c
  UNKNOWN = nil
  # in file ext/zlib/zlib.c
  NO_COMPRESSION = nil
  # in file ext/zlib/zlib.c
  BEST_SPEED = nil
  # in file ext/zlib/zlib.c
  BEST_COMPRESSION = nil
  # in file ext/zlib/zlib.c
  DEFAULT_COMPRESSION = nil
  # in file ext/zlib/zlib.c
  FILTERED = nil
  # in file ext/zlib/zlib.c
  HUFFMAN_ONLY = nil
  # in file ext/zlib/zlib.c
  DEFAULT_STRATEGY = nil
  # in file ext/zlib/zlib.c
  MAX_WBITS = nil
  # in file ext/zlib/zlib.c
  DEF_MEM_LEVEL = nil
  # in file ext/zlib/zlib.c
  MAX_MEM_LEVEL = nil
  # in file ext/zlib/zlib.c
  NO_FLUSH = nil
  # in file ext/zlib/zlib.c
  SYNC_FLUSH = nil
  # in file ext/zlib/zlib.c
  FULL_FLUSH = nil
  # in file ext/zlib/zlib.c
  FINISH = nil
  # in file ext/zlib/zlib.c
  OS_CODE = nil
  # in file ext/zlib/zlib.c
  OS_MSDOS = nil
  # in file ext/zlib/zlib.c
  OS_AMIGA = nil
  # in file ext/zlib/zlib.c
  OS_VMS = nil
  # in file ext/zlib/zlib.c
  OS_UNIX = nil
  # in file ext/zlib/zlib.c
  OS_ATARI = nil
  # in file ext/zlib/zlib.c
  OS_OS2 = nil
  # in file ext/zlib/zlib.c
  OS_MACOS = nil
  # in file ext/zlib/zlib.c
  OS_TOPS20 = nil
  # in file ext/zlib/zlib.c
  OS_WIN32 = nil
  # in file ext/zlib/zlib.c
  OS_VMCMS = nil
  # in file ext/zlib/zlib.c
  OS_ZSYSTEM = nil
  # in file ext/zlib/zlib.c
  OS_CPM = nil
  # in file ext/zlib/zlib.c
  OS_QDOS = nil
  # in file ext/zlib/zlib.c
  OS_RISCOS = nil
  # in file ext/zlib/zlib.c
  OS_UNKNOWN = nil
  # in file ext/zlib/zlib.c
  def adler32(*args); end

  # in file ext/zlib/zlib.c
  def crc32(*args); end

  # in file ext/zlib/zlib.c
  def crc_table(); end

  # in file ext/zlib/zlib.c
  def deflate(*args); end

  # in file ext/zlib/zlib.c
  def inflate(p1); end

  # in file ext/zlib/zlib.c
  def zlib_version(); end

end

# in files:
#   ext/zlib/zlib.c

class Zlib::BufError
end

# in files:
#   ext/zlib/zlib.c

class Zlib::DataError
end

# in files:
#   ext/zlib/zlib.c

class Zlib::MemError
end

# in files:
#   ext/zlib/zlib.c

class Zlib::NeedDict
end

# in files:
#   ext/zlib/zlib.c

class Zlib::StreamEnd
end

# in files:
#   ext/zlib/zlib.c

class Zlib::StreamError
end

# in files:
#   ext/zlib/zlib.c

class Zlib::VersionError
end

class Zlib::GzipFile::Error # is documented

  attr_reader :input # in file ext/zlib/zlib.c
  # in file ext/zlib/zlib.c
  def inspect(); end

end

class Zlib::GzipFile # is documented

  # in file ext/zlib/zlib.c
  def wrap(*args); end

  # in file ext/zlib/zlib.c
  def close(); end

  # in file ext/zlib/zlib.c
  def closed?(); end

  # in file ext/zlib/zlib.c
  def comment(); end

  # in file ext/zlib/zlib.c
  def crc(); end

  # in file ext/zlib/zlib.c
  def finish(); end

  # in file ext/zlib/zlib.c
  def level(); end

  # in file ext/zlib/zlib.c
  def mtime(); end

  # in file ext/zlib/zlib.c
  def orig_name(); end

  # in file ext/zlib/zlib.c
  def os_code(); end

  # in file ext/zlib/zlib.c
  def sync(); end

  # in file ext/zlib/zlib.c
  def sync=(p1); end

  # in file ext/zlib/zlib.c
  def to_io(); end

end



class Zlib::Deflate # is documented

  # in file ext/zlib/zlib.c
  def flush(*args); end

  # in file ext/zlib/zlib.c
  def initialize_copy(p1); end

  # in file ext/zlib/zlib.c
  def params(p1, p2); end

  # in file ext/zlib/zlib.c
  def set_dictionary(p1); end

end


class Zlib::GzipFile # is documented

  # in file ext/zlib/zlib.c
  def crc(); end

  # in file ext/zlib/zlib.c
  def sync=(p1); end

end


class Zlib::GzipFile::Error # is documented

  # in file ext/zlib/zlib.c
  def inspect(); end

end



class Zlib::GzipReader # is documented

  # in file ext/zlib/zlib.c
  def new(*args); end

  # in file ext/zlib/zlib.c
  def open(*args); end

  # in file ext/zlib/zlib.c
  def bytes(); end

  # in file ext/zlib/zlib.c
  def each(*args); end

  # in file ext/zlib/zlib.c
  def each_byte(); end

  # in file ext/zlib/zlib.c
  def each_line(*args); end

  # in file ext/zlib/zlib.c
  def eof(); end

  # in file ext/zlib/zlib.c
  def eof?(); end

  # in file ext/zlib/zlib.c
  def getc(); end

  # in file ext/zlib/zlib.c
  def lineno(); end

  # in file ext/zlib/zlib.c
  def lineno=(p1); end

  # in file ext/zlib/zlib.c
  def lines(*args); end

  # in file ext/zlib/zlib.c
  def pos(); end

  # in file ext/zlib/zlib.c
  def read(*args); end

  # in file ext/zlib/zlib.c
  def readchar(); end

  # in file ext/zlib/zlib.c
  def rewind(); end

  # in file ext/zlib/zlib.c
  def tell(); end

  # in file ext/zlib/zlib.c
  def ungetbyte(p1); end

  # in file ext/zlib/zlib.c
  def ungetc(p1); end

  # in file ext/zlib/zlib.c
  def unused(); end

end

class Zlib::GzipWriter # is documented

  # in file ext/zlib/zlib.c
  def new(*args); end

  # in file ext/zlib/zlib.c
  def open(*args); end

  # in file ext/zlib/zlib.c
  def flush(*args); end

  # in file ext/zlib/zlib.c
  def pos(); end

  # in file ext/zlib/zlib.c
  def tell(); end

  # in file ext/zlib/zlib.c
  def write(p1); end

end

class Zlib::Inflate # is documented

  # in file ext/zlib/zlib.c
  def inflate(p1); end

  # in file ext/zlib/zlib.c
  def new(*args); end

  # in file ext/zlib/zlib.c
  def inflate(p1); end

  # in file ext/zlib/zlib.c
  def set_dictionary(p1); end

  # in file ext/zlib/zlib.c
  def sync(p1); end

  # in file ext/zlib/zlib.c
  def sync_point?(); end

end






class Zlib::ZStream # is documented

  # in file ext/zlib/zlib.c
  def adler(); end

  # in file ext/zlib/zlib.c
  def avail_in(); end

  # in file ext/zlib/zlib.c
  def avail_out(); end

  # in file ext/zlib/zlib.c
  def avail_out=(p1); end

  # in file ext/zlib/zlib.c
  def close(); end

  # in file ext/zlib/zlib.c
  def closed?(); end

  # in file ext/zlib/zlib.c
  def data_type(); end

  # in file ext/zlib/zlib.c
  def end(); end

  # in file ext/zlib/zlib.c
  def ended?(); end

  # in file ext/zlib/zlib.c
  def finish(); end

  # in file ext/zlib/zlib.c
  def finished?(); end

  # in file ext/zlib/zlib.c
  def flush_next_in(); end

  # in file ext/zlib/zlib.c
  def flush_next_out(); end

  # in file ext/zlib/zlib.c
  def reset(); end

  # in file ext/zlib/zlib.c
  def stream_end?(); end

  # in file ext/zlib/zlib.c
  def total_in(); end

  # in file ext/zlib/zlib.c
  def total_out(); end

end



-- 
http://redmine.ruby-lang.org