diff options
Diffstat (limited to 'ext/coverage/coverage.c')
-rw-r--r-- | ext/coverage/coverage.c | 42 |
1 files changed, 39 insertions, 3 deletions
diff --git a/ext/coverage/coverage.c b/ext/coverage/coverage.c index a56a408665..b40b28bc21 100644 --- a/ext/coverage/coverage.c +++ b/ext/coverage/coverage.c @@ -1,11 +1,47 @@ +/************************************************ + + coverage.c - + + $Author: $ + + Copyright (c) 2008 Yusuke Endoh + +************************************************/ + #include "ruby.h" -VALUE rb_mCoverage; +extern void rb_enable_coverages(void); +/* Coverage provides coverage measurement feature for Ruby. + * + * = Usage + * + * (1) require "coverage.so" + * (2) require or load Ruby source file + * (3) Coverage.result will return a hash that contains filename as key and + * coverage array as value. + * + * = Example + * + * [foo.rb] + * s = 0 + * 10.times do |x| + * s += x + * end + * + * if s == 45 + * p :ok + * else + * p :ng + * end + * [EOF] + * + * require "coverage.so" + * require "foo.rb" + * p COVERAGE__ #=> {"foo.rb"=>[1, 1, 10, nil, nil, 1, 1, nil, 0, nil]} + */ void Init_coverage(void) { rb_enable_coverages(); - rb_mCoverage = rb_define_module("Coverage"); - rb_define_module_function(rb_mCoverage, "result", rb_get_coverages, 0); } |