RDoc Metrics

[Tony Arcieri]

[Note: parts of this message were removed to make it a legal post.]

Does there exist a tool for providing basic metrics about the quality of the
RDoc for a given package?

I'd like to be able to get a list of all undocumented classes/methods, and
possibly things like a percentage breakdown of how well methods in
particular classes are documented. Lovely HTML reports for this sort of
thing would rule! I'm thinking of something like RCov for the quality of
our RDoc, if that makes any sense.

Anything I should be looking at in this regard?

 

[Michael Guterl]

Does there exist a tool for providing basic metrics about the quality of = the
RDoc for a given package?

I'd like to be able to get a list of all undocumented classes/methods, an= d
possibly things like a percentage breakdown of how well methods in
particular classes are documented. =C2=A0Lovely HTML reports for this sor= t of
thing would rule! =C2=A0I'm thinking of something like RCov for the quali= ty of
our RDoc, if that makes any sense.

Anything I should be looking at in this regard?

http://dcov.rubyforge.org/ might be what you're looking for.

Best,
Michael Guterl

 

[Tony Arcieri]

[Note: parts of this message were removed to make it a legal post.]

http://dcov.rubyforge.org/ might be what you're looking for.

Excellent! That looks rather promising. I'll check it out.

 

[Roger Pack]

Anything I should be looking at in this regard?

Apparently http://ruby-doc.org/stdlib/ has some metric.

It's either that or you could write a template that just output stats

=r