Velocity Reviews - Computer Hardware Reviews

Velocity Reviews > Newsgroups > Programming > Ruby > RubyInline, RDoc comment for C inline method

Thread Tools

RubyInline, RDoc comment for C inline method

Daniel Schömer
Posts: n/a

I am playing around with RubyInline and want to include
a "inlined" C method to the API documentation generated by rdoc.

Here is an minimal example:

---- a.rb ----
require 'inline'

class A
# Method A.a1
inline do |builder|
# Method A.a2
builder.c %{
* Method A.a3
int a() {
return 0;

# Method A.b
def self.b
---- end of a.rb ----

Calling "rdoc a.rb" generates only the documentation for method
A#b, not A#a.

Is it possible to let rdoc generate the documentation for A#a?
If so, how?

Reply With Quote

Thread Tools

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off

Similar Threads
Thread Thread Starter Forum Replies Last Post
RDoc: How to link to a method description from other rdoc page? Iñaki Baz Castillo Ruby 3 07-28-2009 09:03 PM
Disabling comment processing with rdoc in C extensions Daniel Berger Ruby 1 06-03-2005 11:06 PM
? ELSE Conditional Comment / Using Conditional Comments Inside Other Tags To Comment Out Attributes Alec S. HTML 10 04-16-2005 02:21 AM
rdoc bug (and rdoc bug tracker site is down) Brian Schrder Ruby 5 09-18-2004 02:08 PM
rdoc: how to generate rdoc & ri documentation of standard library? Andreas Schwarz Ruby 6 01-01-2004 03:09 AM