如何使 rdoc 从我的 c 扩展中正确读取方法参数？

Question

总之，我正在使用 rdoc 为包含 C 扩展的 Ruby 代码生成文档，但我的方法参数出现问题。 Rdoc 无法正确解析它们的名称，而是使用 p1、p2 等。

因此，首先，我的扩展实际上是编译为 C++ 的，所以我必须使用如下所示的函数定义：

static VALUE 
MyMethod(VALUE self, VALUE flazm, VALUE saszm)
{
    return Qnil;
}

它看起来像 rdoc 需要旧式“C”像这样的定义：

static VALUE
MyMethod(self, flazm, saszm)
    VALUE self;
    VALUE flazm;
    VALUE saszm;
{
    return Qnil;
}

我有办法让这个工作成功吗？

Answer 1

RDoc 对 C 扩展* 中的参数名称完全一无所知。 这就是 RDoc 编译参数字符串的方式：

meth_obj.params = "(" + (1..p_count).map{|i| "p#{i}"}.join(", ") + ")"

更改源格式不会有帮助。

要改进您的文档，您可以使用 call-seq 指令。 您可以指定一种或多种方法来调用您的方法，这些方法将代替默认的 method(p1, p2) 内容。

/*
 * call-seq:
 *   my_method(flazm, saszm) -> nil
 *   my_method(bunny) { |fluffy_ears| ... } -> true or false
 *
 * Method description here.
 */
static VALUE 
MyMethod(VALUE self, VALUE flazm, VALUE saszm)
{
    return Qnil;
}

* 它对其他一些事情也一无所知。 基于正则表达式的“解析”非常幼稚。