[Fxruby-users] [ANN] Updated API Documentation
Status: Inactive
Brought to you by:
lyle
|
From: Lyle J. <jl...@cf...> - 2003-06-09 16:03:37
|
All,
I've completed the first pass through the FXRuby API documentation,
which is posted here:
http://www.fxruby.org/doc/api
By first pass, I simply mean that I think all of the classes and their
methods and attributes are at least *listed* here. IMO this is now a
much better choice than reading the C++ API documentation and trying to
"translate" that from C++ to Ruby. For example, all of the messages that
various widgets can send to their targets are documented.
More can and should be done. On the "second pass", I want to do a better
job of documenting the types of the method arguments. For example, take
a look at the documentation for FX4Splitter's initialize method:
http://www.fxruby.org/doc/api/classes/Fox/FX4Splitter.html
Here, the individual method arguments and their types are listed in a
sort of table, similar to the format used for JavaDoc. I'd like to use
this approach throughout the documentation.
Another goal is to add short code examples, where appropriate. I'm
trying to decide what is the right balance between reference
documentation -- which is the intent -- and the more expositional style
that you will see in the FXRuby book, due out in approximately the year
2020 ;)
Anyways, hope this is useful and please give me some feedback about what
other kinds of information we can show here.
Thanks,
Lyle
|