Bug #4664

documentation updates 2011-05-10

Added by Vincent Batts almost 3 years ago. Updated almost 3 years ago.

[ruby-core:<unknown>]
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] Backport:

Description

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

The attached patch addresses the following items needing documentation.

class Addrinfo
# in file ext/socket/lib/socket.rb
def connectinternal(localaddrinfo); end
end

class Array
# in file lib/rexml/xpathparser.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

ruby_doc_updates-20110510_vbatts.patch Magnifier (5.04 KB) Vincent Batts, 05/11/2011 01:04 AM

Associated revisions

Revision 31525
Added by Eric Hodel almost 3 years ago

  • object.c (rbobjequal): Add documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #4664]
    • lib/rexml: ditto
    • lib/mkmf.rb: ditto
    • ext/socket/lib/socket.rb: ditto

History

#1 Updated by Eric Hodel almost 3 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r31525.
Vincent, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • object.c (rbobjequal): Add documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #4664]
    • lib/rexml: ditto
    • lib/mkmf.rb: ditto
    • ext/socket/lib/socket.rb: ditto

#2 Updated by Eric Hodel almost 3 years ago

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+

Also available in: Atom PDF