[lnkForumImage]
TotalShareware - Download Free Software

Confronta i prezzi di migliaia di prodotti.
Asp Forum
 Home | Login | Register | Search 


 

Forums >

comp.lang.ruby

rdoc mistakenly picking up C functions

leon breedt

1/22/2005 8:04:00 AM

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


1 Answer

Tilman Sauerbeck

1/22/2005 10:38:00 AM

0

leon breedt <bitserf@gmail.com> [2005-01-22 17:04]:
> 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

--
Regards,
Tilman