Documenting ruby.h and intern.h (was rb_const_get documentation)

ruby-talk
1

E S wrote:
...

In favour of Doxy (or rdoc), the people actually programming might be
more inclined to update the docs if they were present right there in
the source.

In either case, I'm sure www.ruby-doc.org would have the space?

Yes.

Excellent!

BTW, has this:

http://www.ruby-doc.org/doxygen/1.8.1/index.html

been mentioned here yet?

Yep. The problem is that there's no documentation as to
/what/ the functions do (not to mention Doxygen's normal
cumbersome navigation). One can look at the source but,
witness my recent confusion about command-line arguments
that Nakada-dono clarified, it may not be enough :slight_smile:

There's the Ruby Hacking Guide[1] that Daigo Moriwaki mentioned
on Redhanded[2]. Anyone read that, is it on this topic?

James.

E

[1] http://www.amazon.co.jp/exec/obidos/ASIN/4844317210/qid%3D1106059404/250-3696771-8683419
[2] http://redhanded.hobix.com

2

E S wrote:

BTW, has this:

http://www.ruby-doc.org/doxygen/1.8.1/index.html

been mentioned here yet?

Yep. The problem is that there's no documentation as to
/what/ the functions do (not to mention Doxygen's normal
cumbersome navigation). One can look at the source but,
witness my recent confusion about command-line arguments
that Nakada-dono clarified, it may not be enough :slight_smile:

Ah. Well, then perhaps more comments are needed in the source code, and/or a way to annotate the Web pages.

James

3

E S wrote:

There's the Ruby Hacking Guide[1] that Daigo Moriwaki mentioned on Redhanded[2]. Anyone read that, is it on this topic?

You can see for yourself: <http://i.loveruby.net/ja/rhg/&gt;

Sorry. No http://i.loveruby.net/en/rhg/\.

_why

4

* why the lucky stiff <ruby-talk@whytheluckystiff.net> [0145 23:45]:

E S wrote:

>There's the Ruby Hacking Guide[1] that Daigo Moriwaki mentioned on
>Redhanded[2]. Anyone read that, is it on this topic?

You can see for yourself: <http://i.loveruby.net/ja/rhg/&gt;

Sorry. No http://i.loveruby.net/en/rhg/\.

try :

http://makeashorterlink.com/?T28722D4A

(http://www.excite.co.jp/world/english/web/body/?wb_url=http%3A%2F%2Fi.loveruby.net%2Fja%2Frhg%2Findex.html&wb_lp=JAEN&wb_dis=2\)

ยทยทยท

--
'Bender, Ship, stop arguing or I'll come back there and change
your opinions manually.'
    -- Leela
Rasputin :: Jack of All Trades - Master of Nuns