Documentation for C extension

Discussion in 'Ruby' started by Marek Janukowicz, Feb 3, 2004.

  1. I wrote a simple wrapper around Subversion API
    (http://subversion.tigris.org). How should I document it to create
    something like RDoc documentation? The library consists of C files, so I
    cannot write RDoc comments inside... Or maybe I can?

    --
    Marek Janukowicz
     
    Marek Janukowicz, Feb 3, 2004
    #1
    1. Advertising

  2. Marek Janukowicz

    Dave Thomas Guest

    On Feb 3, 2004, at 15:30, Marek Janukowicz wrote:

    >
    > I wrote a simple wrapper around Subversion API
    > (http://subversion.tigris.org). How should I document it to create
    > something like RDoc documentation? The library consists of C files, so
    > I
    > cannot write RDoc comments inside... Or maybe I can?


    Sure you can: RDoc handle C extensions just fine :)

    Have a look at any of the recent .c files in the main Ruby source
    directory for examples.


    Cheers

    Dave
     
    Dave Thomas, Feb 3, 2004
    #2
    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. Cameron Laird
    Replies:
    1
    Views:
    683
    Josiah Carlson
    Apr 3, 2004
  2. Kenneth McDonald
    Replies:
    2
    Views:
    778
  3. Replies:
    1
    Views:
    1,239
    Andy Dingley
    Sep 16, 2006
  4. korean_dave

    win32com extension documentation/API

    korean_dave, Jul 7, 2008, in forum: Python
    Replies:
    1
    Views:
    793
    Mike Driscoll
    Jul 7, 2008
  5. Oleg Leschov
    Replies:
    2
    Views:
    374
    Oleg Leschov
    Dec 24, 2010
Loading...

Share This Page