Re: [rice] documentation for rice extensions
- Jason Roelofs
- 2009-12-31 @ 21:33
On Thu, Dec 31, 2009 at 3:47 PM, Paul Brannan <firstname.lastname@example.org> wrote:
> James (or others),
> Is there a good way to build documentation for rice extensions?
> How hard would it be to write an rdoc plugin for rice?
I haven't given this much thought, but most of my thinking was with rb++
doing some auto-generation of documentation. I know rdoc can read
rdoc-styled comments out of C code, but I don't know how far that goes (e.g.
does it only know about what's in comments or can it deduce methods and
classes from rb_define_ calls?).
Boost.Python's got it pretty easy, as Python has method and class
documentation built right into its object structure. The way I dealt with
documenting a compiled extension before was to build skeleton ruby files and
run rdoc on them. Not a fantastic solution, but it's what I'll probably
start with with rb++, unless we come up with a solution in Rice itself.