From: Yugui <yugui@...>
Date: 2010-12-26T10:40:49+09:00
Subject: [ruby-core:33885] Re: Getting involved in Ruby

Hi Loren,

On Sun, Dec 26, 2010 at 9:52 AM, Loren Segal <lsegal@soen.ca> wrote:
> If we are going to be accepting Doxygen-style @tag based comments, why not
> just start switching over to YARD syntax for both the C API and Ruby
> documentations?
(snip)
> I'd be interested in extending
> support for YARD to better cover the lower level C side of the Ruby API, if
> there was willingness from the Ruby devs to commit to a single syntax for
> documentation.

I wrote a preprocessor that skips RDoc for doxygen,
tool/strip-rdoc.rb.  But your proposal seems much smarter. It is
really exciting.

We need to discuss carefully and need an approval by ruby-core before
changing RDoc into YARD.  Could you post your proposal as a feature
request issue at the redmine?
I worry about difference between what Ruby API reference needs and
what C API reference needs.  Doxygen comment describes how Ruby is
implemented.
A YARD doc for a method implementation will be good for C API doc too.
But I don't hope description like class_alloc()'s appears in Ruby API
documentation. How can we distinguish them?

-- 
Yuki Sonoda (Yugui)
yugui@yugui.jp
http://yugui.jp