Automatic check of RDoc documentation

(Lucas Nussbaum) #1

Hi,

I've documented my project with RDoc, but I have a problem : how do I know
which methods/classes are not documented yet, or even better, which ones are
not well enough documented (like: length of documentation < sthing) ? Does
something like that exist ?

If not, I'd look at coding this. I was thinking of adding a "generator" which
would generate a report about the quality of the documentation instead of the
documentation itself. Do you think this is the good approach ?

Thank you,

···

--

Lucas Nussbaum
lucas@lucas-nussbaum.net http://www.lucas-nussbaum.net/ |
jabber: lucas@nussbaum.fr GPG: 1024D/023B3F4F |

(Lothar Scholz) #2

Hello Lucas,

Hi,

I've documented my project with RDoc, but I have a problem : how do I know
which methods/classes are not documented yet, or even better, which ones are
not well enough documented (like: length of documentation < sthing) ? Does
something like that exist ?

You can try ArachnoRuby. The class browser does take the data from the
generated RI files (which hold the same as RDOC, just in a different
format) and puts a small documented icon behinds it. So you easily see
what methods are not documented. But there is no metric tool for the
second part of your question.

If not, I'd look at coding this. I was thinking of adding a "generator" which
would generate a report about the quality of the documentation instead of the
documentation itself. Do you think this is the good approach ?

Depends, many people who ever worked in larger companies hate this
kind of coding style metrics as a long comment does not mean a good
comment. But sometimes i would like to get some metrics and i'm sure
it will make it easier if we could point volunteers to parts in the
standard library that needs more documentation.

···

--
Best regards, emailto: scholz at scriptolutions dot com
Lothar Scholz http://www.ruby-ide.com
CTO Scriptolutions Ruby, PHP, Python IDE 's