Issue #4664 has been updated by Eric Hodel.


I made a few changes to your patch, mostly removing +Blah+ around constants in order to have those automatically be linked in HTML output.

Also, for connect_internal in Socket the parameter should be surrounded with +param+ when mentioned:

    creates a new Socket connected to the address of +local_addrinfo+
----------------------------------------
Bug #4664: documentation updates 2011-05-10
http://redmine.ruby-lang.org/issues/4664

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-10 trunk 31502) [x86_64-linux]


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


The attached patch addresses the following items needing documentation.

<code>
class Addrinfo
  # in file ext/socket/lib/socket.rb
  def connect_internal(local_addrinfo); end
end

class Array
  # in file lib/rexml/xpath_parser.rb
  def dclone(); end
end
class Fixnum
  # in file lib/rexml/xpath_parser.rb
  def dclone(); end
end
class Float
  # in file lib/rexml/xpath_parser.rb
  def dclone(); end
end

class Object 
  # in file lib/rexml/xpath_parser.rb
  def dclone(); end

  # in file object.c
  def methods(*args); end

  # in file object.c
  def private_methods(*args); end

  # in file object.c
  def protected_methods(*args); end

  # in file object.c
  def public_methods(*args); end

  # in file object.c
  def hash(); end

  # in file lib/mkmf.rb
  def depend_rules(depend); end

  # in file lib/mkmf.rb
  def dummy_makefile(srcdir); end

  # in file lib/mkmf.rb
  def try_const(const, headers = nil, opt = "", &b); end

  # in file lib/mkmf.rb
  def try_type(type, headers = nil, opt = "", &b); end

end

class REXML::XPath # is documented
  # in file lib/rexml/xpath.rb
  EMPTY_HASH = nil
end

</code>


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