RUDE4C - Ruby Documentation Extractor for C

About RUDE4C

RUDE4C generates documentation from Ruby library extensions written in C. It scans the code for expressions like 'rb_define_class' to extract a tree of classes and modules defined by the library. Output is possible as plain text, rd-style docu and HTML.

Usage

Usage: rude4c.rb [options]
  -c, --constants                  print constants
  -f, --format=FORMAT              set output format
  -o, --out=FILE                   set output file
  -m, --methods                    print methods
  -v, --verbose                    be verbose
  -h, --help                       show this message

Output format (-f) is one of 'plain', 'rd', or 'html'. Option -v currently has no effect.

Input is read from STDIN, so a typical call would be:

$ cat *.c | rude4c.rb -f rd -c -m -o doc.rd

If you use conditional compilation with #define and #ifdef you'd better run RUDE4C after the preprocessor has played with the code.

Version

$Id: rude4c.rb,v 1.2 2002/11/12 23:04:24 arno Exp $

License

RUDE4C is Copyright (C) 2002 Arno Erpenbeck. It is free software, and may be redistributed under the terms specified in the README file of the Ruby distribution.

Warranty

This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.

What is processed?

Currently the following C expressions are scanned:

• VALUE rb_define_class(char *name, VALUE superclass)
• VALUE rb_define_module(char *name)
• VALUE rb_define_class_under(VALUE under, char *name, VALUE superclass)
• VALUE rb_define_module_under(VALUE under, char *name)
• void rb_define_method(VALUE classmod, char *name, VALUE (*func)(), int argc)
• void rb_define_module_function(VALUE classmod, char *name, VALUE (*func)(), int argc)
• void rb_define_singleton_method(VALUE classmod, char *name, VALUE (*func)(), int argc)
• void rb_define_alias(VALUE classmod, const char *newname, const char *oldname)
• void rb_define_const(VALUE classmod, char *name, VALUE value)
• void rb_define_class_variable(VALUE class, const char *name, VALUE val)

These expressions may be considered in a future relase:

• void rb_define_global_const(char *name, VALUE value)
• void rb_define_global_function(char *name, VALUE (*func)(), int argc)
• void rb_define_variable(const char *name, VALUE *object)
• void rb_define_readonly_variable(const char *name, VALUE *value)

Download

Download the current version of rude4c here: rude4c.zip

Back to main page.