From: Gavin Sinclair <gsinclair@...>
Date: 2003-12-11T22:47:15+09:00
Subject: Re: Docs for Socket, OpenSSL, etc

On Friday, December 12, 2003, 12:21:42 AM, James wrote:

> On Thu, 11 Dec 2003 22:13:10 +0900
> "James F.  Hranicky" <jfh@cise.ufl.edu> wrote:

>> /*
>>  *  Open a UNIX domain socket, e.g.:
>>  *
>>  *  s = UNIXServer.open("/tmp/sock")
>>  *
>>  *  UNIXServer.open("/tmp/sock") { |s| n = s.accept; n.puts("you connected!") }
>>  */
>> 
>> but as there is no corresponding rb_define_method() entry for UNIXServer.open,
>> it doesn't show up. 
>> 
>> Any pointers on where this should go?

> *smack* duhhh...

> This, and the doc for UNIXServer.new, should go in the initialize doc, right?

# I think you're double posting to ruby-talk.

I'm not sure #open documentation belongs in #initialize.  X#initialize
documentation shows up with X.new in the RDoc.

Lemme see...

Well, it appears that open is an alias for new in (UNIX)?Socket (and
therefore UNIXServer), so you are right.  I dunno how it's done,
though; 'grep open *.c' is singularly uninstructive.

Gavin