From: Hans Fugal <hans@...>
Date: 2004-07-24T07:56:59+09:00
Subject: rdoc on SWIG-generated files

I run rdoc on a SWIG-generated file and it grabs the module, module 
methods, and classes, but it fails to document the methods inside classes.

Perhaps this is because the rb_define_method calls are inside a special 
MACRO block, e.g.:

SWIGEXPORT(void) Init_ladspa(void) {
     int i;

     SWIG_InitRuntime();
     mLADSPA = rb_define_module("LADSPA");

     for (i = 0; swig_types_initial[i]; i++) {
         swig_types[i] = SWIG_TypeRegister(swig_types_initial[i]);
         SWIG_define_class(swig_types[i]);
     }


     cLADSPA_Descriptor.klass = rb_define_class_under(mLADSPA, 
"LADSPA_Descriptor", rb_cObject);
     SWIG_TypeClientData(SWIGTYPE_p_LADSPA_Descriptor, (void *) 
&cLADSPA_Descriptor);
     rb_define_alloc_func(cLADSPA_Descriptor.klass, 
_wrap_LADSPA_Descriptor_allocate);
     rb_define_method(cLADSPA_Descriptor.klass, "initialize", 
_wrap_new_LADSPA_Descriptor, -1);

/* etc. */
}

Is there a workaround to this? Would it be hard to convince rdoc to grok 
it? How do people generally document their SWIG-generated code?