Bug #4677

documentation updates 2011-05-12

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

[ruby-core:36143]
Status:Closed
Priority:Normal
Assignee:Eric Hodel
Category:doc
Target version:1.9.3
ruby -v:Thu May 12 14:17:22 EDT 2011 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, including the entirety of URI and subclasses/modules:

class Regexp
# in file re.c
IGNORECASE = nil
# in file re.c
EXTENDED = nil
# in file re.c
MULTILINE = nil
# in file re.c
FIXEDENCODING = nil
# in file re.c
NOENCODING = nil
end

module Process # is documented
# in file process.c
WNOHANG = nil
# in file process.c
WUNTRACED = nil
# in file process.c
PRIOPROCESS = nil
# in file process.c
PRIO
PGRP = nil
# in file process.c
PRIOUSER = nil
# in file process.c
RLIM
SAVEDMAX = nil
# in file process.c
RLIM
INFINITY = nil
# in file process.c
RLIMSAVEDCUR = nil
# in file process.c
RLIMITAS = nil
# in file process.c
RLIMIT
CORE = nil
# in file process.c
RLIMITCPU = nil
# in file process.c
RLIMIT
DATA = nil
# in file process.c
RLIMITFSIZE = nil
# in file process.c
RLIMIT
MEMLOCK = nil
# in file process.c
RLIMITMSGQUEUE = nil
# in file process.c
RLIMIT
NICE = nil
# in file process.c
RLIMITNOFILE = nil
# in file process.c
RLIMIT
NPROC = nil
# in file process.c
RLIMITRSS = nil
# in file process.c
RLIMIT
RTPRIO = nil
# in file process.c
RLIMITRTTIME = nil
# in file process.c
RLIMIT
SBSIZE = nil
# in file process.c
RLIMITSIGPENDING = nil
# in file process.c
RLIMIT
STACK = nil
end

module URI # is documented
# in file lib/uri/common.rb
DEFAULTPARSER = nil
# in file lib/uri/common.rb
def scheme
list(); end
end
class URI::Generic # is documented
# in file lib/uri/generic.rb
DEFAULTPORT = nil
# in file lib/uri/generic.rb
COMPONENT = nil
# in file lib/uri/generic.rb
USE
REGISTRY = nil
attrreader :scheme # in file lib/uri/generic.rb
attr
reader :port # in file lib/uri/generic.rb
attrreader :registry # in file lib/uri/generic.rb
attr
reader :path # in file lib/uri/generic.rb
attrreader :query # in file lib/uri/generic.rb
attr
reader :opaque # in file lib/uri/generic.rb
attrreader :fragment # in file lib/uri/generic.rb
# in file lib/uri/generic.rb
def check
fragment(v); end
# in file lib/uri/generic.rb
def checkhost(v); end
# in file lib/uri/generic.rb
def check
opaque(v); end
# in file lib/uri/generic.rb
def checkpassword(v, user = @user); end
# in file lib/uri/generic.rb
def check
path(v); end
# in file lib/uri/generic.rb
def checkport(v); end
# in file lib/uri/generic.rb
def check
query(v); end
# in file lib/uri/generic.rb
def checkregistry(v); end
# in file lib/uri/generic.rb
def check
scheme(v); end
# in file lib/uri/generic.rb
def checkuser(v); end
# in file lib/uri/generic.rb
def check
userinfo(user, password = nil); end
# in file lib/uri/generic.rb
def coerce(oth); end
# in file lib/uri/generic.rb
def component(); end
# in file lib/uri/generic.rb
def componentary(); end
# in file lib/uri/generic.rb
def default
port(); end
# in file lib/uri/generic.rb
def escapeuserpass(v); end
# in file lib/uri/generic.rb
def fragment=(v); end
# in file lib/uri/generic.rb
def host=(v); end
# in file lib/uri/generic.rb
def merge
path(base, rel); end
# in file lib/uri/generic.rb
def opaque=(v); end
# in file lib/uri/generic.rb
def parser(); end
# in file lib/uri/generic.rb
def password(); end
# in file lib/uri/generic.rb
def password=(password); end
# in file lib/uri/generic.rb
def path=(v); end
# in file lib/uri/generic.rb
def pathquery(); end
# in file lib/uri/generic.rb
def port=(v); end
# in file lib/uri/generic.rb
def query=(v); end
# in file lib/uri/generic.rb
def registry=(v); end
# in file lib/uri/generic.rb
def route
from0(oth); end
# in file lib/uri/generic.rb
def routefrompath(src, dst); end
# in file lib/uri/generic.rb
def scheme=(v); end
# in file lib/uri/generic.rb
def setfragment(v); end
# in file lib/uri/generic.rb
def set
host(v); end
# in file lib/uri/generic.rb
def setopaque(v); end
# in file lib/uri/generic.rb
def set
password(v); end
# in file lib/uri/generic.rb
def setpath(v); end
# in file lib/uri/generic.rb
def set
port(v); end
# in file lib/uri/generic.rb
def setquery(v); end
# in file lib/uri/generic.rb
def set
registry(v); end
# in file lib/uri/generic.rb
def setscheme(v); end
# in file lib/uri/generic.rb
def set
user(v); end
# in file lib/uri/generic.rb
def setuserinfo(user, password = nil); end
# in file lib/uri/generic.rb
def split
path(path); end
# in file lib/uri/generic.rb
def split_userinfo(ui); end
# in file lib/uri/generic.rb
def user(); end
# in file lib/uri/generic.rb
def user=(user); end
# in file lib/uri/generic.rb
def userinfo(); end
end

in files:

lib/uri/common.rb

module URI::Escape
end

class URI::FTP # is documented
# in file lib/uri/ftp.rb
DEFAULTPORT = nil
# in file lib/uri/ftp.rb
COMPONENT = nil
# in file lib/uri/ftp.rb
TYPECODE
PREFIX = nil
attrreader :typecode # in file lib/uri/ftp.rb
# in file lib/uri/ftp.rb
def new2(user, password, host, port, path, typecode = nil, arg
check = true); end
# in file lib/uri/ftp.rb
def checktypecode(v); end
# in file lib/uri/ftp.rb
def set
path(v); end
# in file lib/uri/ftp.rb
def set_typecode(v); end
# in file lib/uri/ftp.rb
def typecode=(typecode); end
end

class URI::HTTP # is documented
# in file lib/uri/http.rb
DEFAULT_PORT = nil
# in file lib/uri/http.rb
COMPONENT = nil
end

class URI::HTTPS # is documented
# in file lib/uri/https.rb
DEFAULT_PORT = nil
end

class URI::LDAP # is documented

# in file lib/uri/ldap.rb
DEFAULT_PORT = nil
# in file lib/uri/ldap.rb
COMPONENT = nil
# in file lib/uri/ldap.rb
SCOPE = nil
# in file lib/uri/ldap.rb
def build(args); end

# in file lib/uri/ldap.rb
def new(*arg); end

# in file lib/uri/ldap.rb
def attributes(); end

# in file lib/uri/ldap.rb
def attributes=(val); end

# in file lib/uri/ldap.rb
def buildpathquery(); end

# in file lib/uri/ldap.rb
def dn(); end

# in file lib/uri/ldap.rb
def dn=(val); end

# in file lib/uri/ldap.rb
def extensions(); end

# in file lib/uri/ldap.rb
def extensions=(val); end

# in file lib/uri/ldap.rb
def filter(); end

# in file lib/uri/ldap.rb
def filter=(val); end

# in file lib/uri/ldap.rb
def parse_dn(); end

# in file lib/uri/ldap.rb
def parse_query(); end

# in file lib/uri/ldap.rb
def scope(); end

# in file lib/uri/ldap.rb
def scope=(val); end

# in file lib/uri/ldap.rb
def set_attributes(val); end

# in file lib/uri/ldap.rb
def set_dn(val); end

# in file lib/uri/ldap.rb
def set_extensions(val); end

# in file lib/uri/ldap.rb
def set_filter(val); end

# in file lib/uri/ldap.rb
def set_scope(val); end

end

class URI::LDAPS # is documented

# in file lib/uri/ldaps.rb
DEFAULT_PORT = nil
end

class URI::MailTo # is documented

# in file lib/uri/mailto.rb
DEFAULTPORT = nil
# in file lib/uri/mailto.rb
COMPONENT = nil
# in file lib/uri/mailto.rb
def check
headers(v); end

# in file lib/uri/mailto.rb
def check_to(v); end

# in file lib/uri/mailto.rb
def headers=(v); end

# in file lib/uri/mailto.rb
def set_headers(v); end

# in file lib/uri/mailto.rb
def set_to(v); end

# in file lib/uri/mailto.rb
def to=(v); end

end

in files:

lib/uri/common.rb

module URI::REGEXP
end

in files:

lib/uri/common.rb

class URI::Parser

attrreader :pattern # in file lib/uri/common.rb
attr
reader :regexp # in file lib/uri/common.rb
# in file lib/uri/common.rb
def escape(str, unsafe = @regexp[:UNSAFE]); end

# in file lib/uri/common.rb
def extract(str, schemes = nil, &block); end

# in file lib/uri/common.rb
def initialize_pattern(opts = {}); end

# in file lib/uri/common.rb
def initialize_regexp(pattern); end

# in file lib/uri/common.rb
def join(*uris); end

# in file lib/uri/common.rb
def make_regexp(schemes = nil); end

# in file lib/uri/common.rb
def parse(uri); end

# in file lib/uri/common.rb
def split(uri); end

# in file lib/uri/common.rb
def unescape(str, escaped = @regexp[:ESCAPED]); end

end

ruby_doc_updates-20110512_vbatts.patch Magnifier (39 KB) Vincent Batts, 05/13/2011 03:20 AM

Associated revisions

Revision 31536
Added by Eric Hodel almost 3 years ago

  • re.c (Init_Regexp): Document option constants. Patch by Vincent Batts. [Ruby 1.9 - Bug #4677]
    • lib/uri/common.rb (module URI): Documentation for URI. Patch by Vincent Batts. [Ruby 1.9- Bug #4677]
    • lib/uri/ftp.rb (module URI): ditto
    • lib/uri/generic.rb (module URI): ditto
    • lib/uri/http.rb (module URI): ditto
    • lib/uri/https.rb (module URI): ditto
    • lib/uri/ldap.rb (module URI): ditto
    • lib/uri/ldaps.rb (module URI): ditto
    • lib/uri/mailto.rb (module URI): ditto
    • process.c (Init_process): Document Process constants. Patch by Vincent Batts. [Ruby 1.9- Bug #4677]

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 r31536.
Vincent, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • re.c (Init_Regexp): Document option constants. Patch by Vincent Batts. [Ruby 1.9 - Bug #4677]
    • lib/uri/common.rb (module URI): Documentation for URI. Patch by Vincent Batts. [Ruby 1.9- Bug #4677]
    • lib/uri/ftp.rb (module URI): ditto
    • lib/uri/generic.rb (module URI): ditto
    • lib/uri/http.rb (module URI): ditto
    • lib/uri/https.rb (module URI): ditto
    • lib/uri/ldap.rb (module URI): ditto
    • lib/uri/ldaps.rb (module URI): ditto
    • lib/uri/mailto.rb (module URI): ditto
    • process.c (Init_process): Document Process constants. Patch by Vincent Batts. [Ruby 1.9- Bug #4677]

#2 Updated by Eric Hodel almost 3 years ago

For the re.c patch I moved the documentation above the constant definition. RDoc doesn't pick up documentation on the same line for C files.

Also available in: Atom PDF