rdoc mistakenly picking up C functions

[leon breedt]

hi,

i have some C functions in an extension i'm documenting that are
commented out (disabled) with C comments, but rdoc still generates
rdoc for them. the rb_define_method calls are also commented out.

i.e.

/*
rb_define_method("xxx", ...)
rb_define_method("yyy", ...)
*/

this should not be documented, in my mind, as those methods are going
to be MIA at runtime.

leon

 

[Tilman Sauerbeck]

i have some C functions in an extension i'm documenting that are
commented out (disabled) with C comments, but rdoc still generates
rdoc for them. the rb_define_method calls are also commented out.

i.e.

/*
rb_define_method("xxx", ...)
rb_define_method("yyy", ...)
*/

this should not be documented, in my mind, as those methods are going
to be MIA at runtime.

Yeah. atm, rdoc only handles C++ style comments:

(parse_c.rb)

def remove_commented_out_lines
@body.gsub!(%r{//.*rb_define_}, '//')
end

Shouldn't be too hard to make it respect C style comments, too, though
;D