Feature Requests: Browse | Submit New | Admin

[#10449] RDoc

Date:
2007-04-29 17:15
Priority:
3
Submitted By:
Evan Light (sleight42)
Assigned To:
Alex Fenton (brokentoy)
Category:
Documentation
State:
Open
Summary:
RDoc

Detailed description
It would be hugely beneficial if wxRuby's documentation was in the more friendly RDoc format than its current.

Add A Comment: Notepad

Please login


Followup

Message
Date: 2009-02-23 18:09
Sender: Alex Fenton

Note - exploring using Yardoc; RDoc isn't sophisticated enough
to deal with wxRuby which really needs type hints on method arguments
and some way to deal with overloaded methods.

Date: 2008-03-07 01:02
Sender: Alex Fenton

Parameters to methods are now links to the relevant classes -
so a method accepting a Wx::Point argument will link to that
class.

Hope this is OK?
Date: 2007-04-29 18:49
Sender: Evan Light

I'm sorry.  I should've been more specific: hyperlinks
within the comment text is what seems the most necessary. 
Right now, a Sizer method may refer to the Window class
within the Sizer method's comment but that reference is not
a link to the Window class.
Date: 2007-04-29 17:57
Sender: Evan Light

Hyperlinks between classes and class#method within Wx would
be  useful.
Date: 2007-04-29 17:52
Sender: Alex Fenton

We previously looked at using RDoc, but it's poorly designed
for C extensions, particularly those that use SWIG. FXRuby maintains
a whole shadow set of ruby lib files just to use RDoc, but that
didn't appeal...

What in particular do you like about the RDoc format? I don't
think we'll be able to make it work with ri, but probably wouldn't
be too hard to offer framed output with class/method indexes.

Attached Files:

Name Description Download
No Files Currently Attached

Changes:

No Changes Have Been Made to This Item