Re: [ruby-gnome2-devel-en] Documentation

[Masao M. <mu...@hi...>]

Hi,

On Mon, 28 Oct 2002 10:47:57 -0700
"Joshua Keith" <jos...@li...> wrote:

> To get an update on the status of the docs, take a look at
> http://www.ruby-gnome2.netfirms.com/api-main.html for the 
> Ruby-GNOME2 API docs, or http://www.ruby-gnome2.netfirms.com/toc.htm 
> for the Ruby-GNOME2 tutorial. Please be aware that the docs are not 
> even pre-alpha yet, but I am working on them and I will try and keep 
> up with changes of the API as I go along.

Great.

My comments are:
Both of documents
* Deprecated/Obsolete/Enable broken classes/methods will be all removed 
  before 0.1 will be released(Already some classes/methods have removed.
  They won't implement in Ruby-GNOME2.

api-main.html
* setter/getter/is_ methods have some rules. 
  Some methods have aliases. For example Gtk::CellRendererToggle#active=, #set_active.
  They are all needed.
  *NOTICE* Some methods are auto-generated. You should check it in rbbr or my script.
* Devide public/protected/private methods and also signals/properties/constants/etc.
* I don't like static type definition style and they are not Ruby-type ....
  Ruby-GNOME2 users do not need to recognize C and GTK+. 
  You should express API reference with Ruby class/modules only
  (int or bool or string or GtkWindow are not Ruby class/modules).

OK, I write an first example what I want.
I'll send here it by RD tonight.


P.S.
Do you know ruby-doc project ?
I don't know what the project do. But it may be helpful for you.

-- 
.:% Masao Mutoh<mu...@hi...>