diff options
Diffstat (limited to 'ext')
| -rw-r--r-- | ext/coverage/coverage.c | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/ext/coverage/coverage.c b/ext/coverage/coverage.c index 529fac256a..d2cdb357e0 100644 --- a/ext/coverage/coverage.c +++ b/ext/coverage/coverage.c @@ -71,11 +71,13 @@ rb_coverage_result(VALUE klass) * * = Usage * - * (1) require "coverage.so" - * (2) do Coverage.start - * (3) require or load Ruby source file - * (4) Coverage.result will return a hash that contains filename as key and - * coverage array as value. + * 1. require "coverage.so" + * 2. do Coverage.start + * 3. require or load Ruby source file + * 4. Coverage.result will return a hash that contains filename as key and + * coverage array as value. A coverage array gives, for each line, the + * number of line execution by the interpreter. A +nil+ value means + * coverage is disabled for this line (lines like +else+ and +end+). * * = Example * |