diff options
| -rw-r--r-- | ChangeLog | 13 | ||||
| -rw-r--r-- | ext/date/date_core.c | 1 | ||||
| -rw-r--r-- | ext/dbm/dbm.c | 5 | ||||
| -rw-r--r-- | ext/dl/cfunc.c | 4 | ||||
| -rw-r--r-- | ext/gdbm/gdbm.c | 2 | ||||
| -rw-r--r-- | ext/io/wait/wait.c | 2 | ||||
| -rw-r--r-- | ext/json/generator/generator.c | 10 | ||||
| -rw-r--r-- | ext/socket/option.c | 1 | ||||
| -rw-r--r-- | ext/stringio/stringio.c | 3 | ||||
| -rw-r--r-- | ext/win32ole/win32ole.c | 2 | ||||
| -rw-r--r-- | ext/zlib/zlib.c | 14 |
11 files changed, 44 insertions, 13 deletions
@@ -1,3 +1,16 @@ +Tue Apr 16 12:25:00 2013 Zachary Scott <zachary@zacharyscott.net> + + * ext/socket/option.c: Document synonymous methods, by windwiny [GH-277] + * ext/stringio/stringio.c: ditto + * ext/io/wait/wait.c: ditto + * ext/gdbm/gdbm.c: ditto + * ext/dl/cfunc.c: ditto + * ext/zlib/zlib.c: ditto + * ext/win32ole/win32ole.c: ditto + * ext/dbm/dbm.c: ditto + * ext/json/generator/generator.c: ditto + * ext/date/date_core.c: ditto + Tue Apr 16 11:23:00 2013 Zachary Scott <zachary@zacharyscott.net> * ext/openssl/*: Document synonymous methods, by windwiny [GH-277] diff --git a/ext/date/date_core.c b/ext/date/date_core.c index 914b81eeaa..45c136c234 100644 --- a/ext/date/date_core.c +++ b/ext/date/date_core.c @@ -5935,6 +5935,7 @@ d_lite_prev_day(int argc, VALUE *argv, VALUE self) /* * call-seq: + * d.succ -> date * d.next -> date * * Returns a date object denoting the following day. diff --git a/ext/dbm/dbm.c b/ext/dbm/dbm.c index 57d227e8ad..27ade017e1 100644 --- a/ext/dbm/dbm.c +++ b/ext/dbm/dbm.c @@ -655,6 +655,7 @@ fdbm_store(VALUE obj, VALUE keystr, VALUE valstr) /* * call-seq: * dbm.length -> integer + * dbm.size -> integer * * Returns the number of entries in the database. */ @@ -832,7 +833,10 @@ fdbm_values(VALUE obj) /* * call-seq: + * dbm.include?(key) -> boolean * dbm.has_key?(key) -> boolean + * dbm.member?(key) -> boolean + * dbm.key?(key) -> boolean * * Returns true if the database contains the specified key, false otherwise. */ @@ -859,6 +863,7 @@ fdbm_has_key(VALUE obj, VALUE keystr) /* * call-seq: * dbm.has_value?(value) -> boolean + * dbm.value?(value) -> boolean * * Returns true if the database contains the specified string value, false * otherwise. diff --git a/ext/dl/cfunc.c b/ext/dl/cfunc.c index 2a96b30bed..b68129f8ed 100644 --- a/ext/dl/cfunc.c +++ b/ext/dl/cfunc.c @@ -285,7 +285,9 @@ rb_dlcfunc_set_ptr(VALUE self, VALUE addr) } /* - * call-seq: inspect + * call-seq: + * inspect + * to_s * * Returns a string formatted with an easily readable representation of the * internal state of the DL::CFunc diff --git a/ext/gdbm/gdbm.c b/ext/gdbm/gdbm.c index 9d958d54a2..45ed9594a7 100644 --- a/ext/gdbm/gdbm.c +++ b/ext/gdbm/gdbm.c @@ -953,7 +953,9 @@ fgdbm_values(VALUE obj) /* * call-seq: + * gdbm.include?(k) -> true or false * gdbm.has_key?(k) -> true or false + * gdbm.member?(k) -> true or false * gdbm.key?(k) -> true or false * * Returns true if the given key _k_ exists within the database. diff --git a/ext/io/wait/wait.c b/ext/io/wait/wait.c index c7a290fd4f..d8bb55fc47 100644 --- a/ext/io/wait/wait.c +++ b/ext/io/wait/wait.c @@ -96,6 +96,8 @@ io_ready_p(VALUE io) * call-seq: * io.wait -> IO, true, false or nil * io.wait(timeout) -> IO, true, false or nil + * io.wait_readable -> IO, true, false or nil + * io.wait_readable(timeout) -> IO, true, false or nil * * Waits until input is available or times out and returns self or nil when * EOF is reached. diff --git a/ext/json/generator/generator.c b/ext/json/generator/generator.c index ae4593c940..42a1658811 100644 --- a/ext/json/generator/generator.c +++ b/ext/json/generator/generator.c @@ -1178,11 +1178,11 @@ static VALUE cState_array_nl_set(VALUE self, VALUE array_nl) /* -* call-seq: check_circular? -* -* Returns true, if circular data structures should be checked, -* otherwise returns false. -*/ + * call-seq: check_circular? + * + * Returns true, if circular data structures should be checked, + * otherwise returns false. + */ static VALUE cState_check_circular_p(VALUE self) { GET_STATE(self); diff --git a/ext/socket/option.c b/ext/socket/option.c index e8dadf4a56..0259613972 100644 --- a/ext/socket/option.c +++ b/ext/socket/option.c @@ -127,6 +127,7 @@ sockopt_optname_m(VALUE self) /* * call-seq: * sockopt.data => string + * sockopt.to_s => string * * returns the socket option data as a string. * diff --git a/ext/stringio/stringio.c b/ext/stringio/stringio.c index 26872e0978..0aad063b5e 100644 --- a/ext/stringio/stringio.c +++ b/ext/stringio/stringio.c @@ -1331,6 +1331,8 @@ strio_read(int argc, VALUE *argv, VALUE self) /* * call-seq: * strio.sysread(integer[, outbuf]) -> string + * strio.readpartial(integer[, outbuf]) -> string + * strio.read_nonblock(integer[, outbuf]) -> string * * Similar to #read, but raises +EOFError+ at end of string instead of * returning +nil+, as well as IO#sysread does. @@ -1363,6 +1365,7 @@ strio_sysread(int argc, VALUE *argv, VALUE self) /* * call-seq: + * strio.length -> integer * strio.size -> integer * * Returns the size of the buffer string. diff --git a/ext/win32ole/win32ole.c b/ext/win32ole/win32ole.c index 37fa1c63c8..8c243f83c1 100644 --- a/ext/win32ole/win32ole.c +++ b/ext/win32ole/win32ole.c @@ -5752,7 +5752,7 @@ ole_type_visible(ITypeInfo *pTypeInfo) /* * call-seq: - * WIN32OLE_TYPE#visible #=> true or false + * WIN32OLE_TYPE#visible? #=> true or false * * Returns true if the OLE class is public. * tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application') diff --git a/ext/zlib/zlib.c b/ext/zlib/zlib.c index e5a1e670f7..64a3e697c6 100644 --- a/ext/zlib/zlib.c +++ b/ext/zlib/zlib.c @@ -1293,12 +1293,8 @@ rb_zstream_finish(VALUE obj) /* * call-seq: - * flush_next_out -> String - * flush_next_out { |chunk| ... } -> nil + * flush_next_in -> input * - * Flushes output buffer and returns all data in that buffer. If a block is - * given each chunk is yielded to the block until the current output buffer - * has been flushed. */ static VALUE rb_zstream_flush_next_in(VALUE obj) @@ -1313,7 +1309,13 @@ rb_zstream_flush_next_in(VALUE obj) } /* - * Flushes output buffer and returns all data in that buffer. + * call-seq: + * flush_next_out -> String + * flush_next_out { |chunk| ... } -> nil + * + * Flushes output buffer and returns all data in that buffer. If a block is + * given each chunk is yielded to the block until the current output buffer + * has been flushed. */ static VALUE rb_zstream_flush_next_out(VALUE obj) |