Forum: Ruby rdoc question: C v Ruby

Announcement (2017-05-07): www.ruby-forum.com is now read-only since I unfortunately do not have the time to support and maintain the forum any more. Please see rubyonrails.org/community and ruby-lang.org/en/community for other Rails- und Ruby-related community platforms.
D71284e011fc1db85804d55515f7d5b8?d=identicon&s=25 Sven C. Koehler (Guest)
on 2009-04-03 15:11
(Received via mailing list)
Hello,

I have one class that gets defined in C and has some methods which were
easier to write in Ruby (so there's rbmodule.c and module.rb, which
extends the class with some methods) .  I've documented both the methods
in C and the ones in Ruby (including a general explanation of the
class).
When I run rdoc, however, it only uses the inline documentation from the
C file and not the inline documentation I wrote in the Ruby part of the
class.  Is there maybe another way to organize the rdoc?

Best,

Sven
58479f76374a3ba3c69b9804163f39f4?d=identicon&s=25 Eric Hodel (Guest)
on 2009-04-03 22:34
(Received via mailing list)
On Apr 3, 2009, at 06:10, Sven C. Koehler wrote:
> the
> class.  Is there maybe another way to organize the rdoc?

This is correct.  Which RDoc are you using?  The latest is 2.4.3.
D71284e011fc1db85804d55515f7d5b8?d=identicon&s=25 Sven C. Koehler (Guest)
on 2009-04-04 21:29
(Received via mailing list)
On Sat, Apr 04, 2009 at 05:31:54AM +0900, Eric Hodel wrote:
>> C file and not the inline documentation I wrote in the Ruby part of
>> the
>> class.  Is there maybe another way to organize the rdoc?
>
> This is correct.  Which RDoc are you using?  The latest is 2.4.3.

I am using RDoc V1.0.1 - 20041108, which seems to be the version that
comes with ruby 1.8.6.  Would separating the documentation into an extra
file, like modulename.rdoc, work better with older rdoc versions like
this one?

-S.
58479f76374a3ba3c69b9804163f39f4?d=identicon&s=25 Eric Hodel (Guest)
on 2009-04-06 07:37
(Received via mailing list)
On Apr 4, 2009, at 12:28, Sven C. Koehler wrote:
>>> the
> this one?
Installing the latest RDoc would be the best solution.  RDoc 1.x is
unmaintained, and nearly unmaintainable.
This topic is locked and can not be replied to.