RubyInline, RDoc comment for C inline method

Discussion in 'Ruby' started by Daniel Schömer, Nov 2, 2008.

  1. Hi,

    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;
    }
    }
    end

    # Method A.b
    def self.b
    0
    end
    end
    ---- 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?

    Daniel
    Daniel Schömer, Nov 2, 2008
    #1
    1. Advertising

Want to reply to this thread or ask your own question?

It takes just 2 minutes to sign up (and it's free!). Just click the sign up button to choose a username and then you can ask your own questions on the forum.
Similar Threads
  1. Alec S.
    Replies:
    10
    Views:
    10,091
    Alec S.
    Apr 16, 2005
  2. Daniel Berger
    Replies:
    1
    Views:
    110
    Nikolai Weibull
    Jun 4, 2005
  3. lists

    No rdoc for RubyInline?

    lists, Aug 5, 2006, in forum: Ruby
    Replies:
    0
    Views:
    81
    lists
    Aug 5, 2006
  4. Daniel Berger
    Replies:
    3
    Views:
    133
    Eric Hodel
    Oct 2, 2006
  5. Iñaki Baz Castillo
    Replies:
    3
    Views:
    139
    Eric Hodel
    Jul 28, 2009
Loading...

Share This Page