Rich Morin wrote:> At 1:39 PM -0700 9/23/05, Rafael Szuminski wrote:
>
>> I am working on adding the API into the Dreamweaver
"intellisense".
>> Does anybody know of a list, text file etc listing all the instance
>> methods, helpers etc.? I have seen DevBoi addin for Firefox and
>> would imagine that this was done based on a "list" like that.
>
>
> I am also interested in this question, but I''m afraid that the
data
> is not in a readily accessible form. AFAICT, Rdoc''s API
information
> is only available as HTML or as formatted ASCII. I''d love to know
> of a way to get at this information in a program-friendly manner
> (e.g., as a YAML file or in a DBMS).
>
> Of course, I''d also like to see Rails get applied to the problem
of
> automated source documentation...
You could run RDoc on the Rails code using a different output template
(see the documentation for RDoc::Page at
http://rdoc.sourceforge.net/doc/ ). It looks as if RDoc is not as
"pluggable" as JavaDoc - you can only vary the template, rather than
being able to plug in a "Doclet" - but this should let you generate
XML,
and possibly YAML.
Note that I haven''t tried this - it''s just a suggested
direction.
I''m a bit concerned that the documentation I found is from Dave
Thomas''s
Sourceforge project, which is now inactive, as RDoc has become part of
the Ruby core. I don''t know where the definitive documentation is to be
found.
regards
Justin