From 59ed57abf542b89babf595e5508cba42ceb9fd47 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Fri, 25 Feb 2011 16:48:11 +0000 Subject: doc: more consistent references for kgio_wait_*able methods Much nicer this way... --- ext/kgio/connect.c | 9 ++++++--- ext/kgio/read_write.c | 4 ++-- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/ext/kgio/connect.c b/ext/kgio/connect.c index 8a91ea2..3b40054 100644 --- a/ext/kgio/connect.c +++ b/ext/kgio/connect.c @@ -98,7 +98,8 @@ static VALUE tcp_connect(VALUE klass, VALUE ip, VALUE port, int io_wait) * Creates a new Kgio::TCPSocket object and initiates a * non-blocking connection. * - * This may block and call any method defined to kgio_wait_writable. + * This may block and call any method defined to +kgio_wait_writable+ + * for the class. * * Unlike the TCPSocket.new in Ruby, this does NOT perform DNS * lookups (which is subject to a different set of timeouts and @@ -155,7 +156,8 @@ static VALUE unix_connect(VALUE klass, VALUE path, int io_wait) * Creates a new Kgio::UNIXSocket object and initiates a * non-blocking connection. * - * This may block and call any method defined to kgio_wait_writable. + * This may block and call any method defined to +kgio_wait_writable+ + * for the class. */ static VALUE kgio_unix_connect(VALUE klass, VALUE path) { @@ -212,7 +214,8 @@ static VALUE stream_connect(VALUE klass, VALUE addr, int io_wait) * Creates a generic Kgio::Socket object and initiates a * non-blocking connection. * - * This may block and call any method assigned to kgio_wait_writable. + * This may block and call any method defined to +kgio_wait_writable+ + * for the class. */ static VALUE kgio_connect(VALUE klass, VALUE addr) { diff --git a/ext/kgio/read_write.c b/ext/kgio/read_write.c index 54e5c82..f43942e 100644 --- a/ext/kgio/read_write.c +++ b/ext/kgio/read_write.c @@ -126,7 +126,7 @@ retry: * Reads at most maxlen bytes from the stream socket. Returns with a * newly allocated buffer, or may reuse an existing buffer if supplied. * - * Calls whatever is is defined to be the kgio_wait_readable method + * This may block and call any method defined to +kgio_wait_readable+ * for the class. * * Returns nil on EOF. @@ -359,7 +359,7 @@ retry: * * Returns nil when the write completes. * - * Calls whatever is is defined to be the kgio_wait_writable method + * This may block and call any method defined to +kgio_wait_writable+ * for the class. */ static VALUE kgio_write(VALUE io, VALUE str) -- cgit v1.2.3-24-ge0c7