# RDoc Metrics

**URL:** <https://www.ruby-forum.com/t/rdoc-metrics/171702>\
**Category:** Ruby\
**Created:** [July 7, 2009, 10:16pm UTC](https://www.ruby-forum.com/t/rdoc-metrics/171702 "2009-07-07T22:16:11Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![murfhy](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/d26b3c/32.png) [@murfhy](https://www.ruby-forum.com/u/murfhy)\
**Post date:** [July 7, 2009, 10:16pm UTC](https://www.ruby-forum.com/t/rdoc-metrics/171702/1 "2009-07-07T22:16:11Z")

</div>

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?

---

<div class="post-metadata">

**Author:** ![murfhy](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/d26b3c/32.png) [@murfhy](https://www.ruby-forum.com/u/murfhy)\
**Post date:** [July 7, 2009, 10:34pm UTC](https://www.ruby-forum.com/t/rdoc-metrics/171702/2 "2009-07-07T22:34:17Z")

</div>

On Tue, Jul 7, 2009 at 4:15 PM, Tony A.[removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> 

[http://dcov.rubyforge.org/](http://dcov.rubyforge.org/) might be what you’re looking for.

Best,  
Michael G.

---

<div class="post-metadata">

**Author:** ![murfhy](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/d26b3c/32.png) [@murfhy](https://www.ruby-forum.com/u/murfhy)\
**Post date:** [July 7, 2009, 10:36pm UTC](https://www.ruby-forum.com/t/rdoc-metrics/171702/3 "2009-07-07T22:36:03Z")

</div>

On Tue, Jul 7, 2009 at 2:33 PM, Michael G. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)  
wrote:

> [http://dcov.rubyforge.org/](http://dcov.rubyforge.org/) might be what you’re looking for.

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

---

<div class="post-metadata">

**Author:** ![murfhy](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/d26b3c/32.png) [@murfhy](https://www.ruby-forum.com/u/murfhy)\
**Post date:** [July 8, 2009, 12:02am UTC](https://www.ruby-forum.com/t/rdoc-metrics/171702/4 "2009-07-08T00:02:23Z")

</div>

> Anything I should be looking at in this regard?

Apparently [RDoc Documentation](http://ruby-doc.org/stdlib/) has some metric.

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

=r