Inch evaluates inline-docs and reports grades for each class, module and method.
Inch was created to help people document their code, therefore it may be more important to look at what it does not do than at what it does.
Inch takes a more relaxed approach towards documentation measurement and tries to show you places where your codebase could use more documentation.
Inch assigns grades to each class, module, constant or function in a codebase, based on how complete the docs are.
The grades are:
A- Seems really good
B- Properly documented, but could be improved
C- Needs work
Using this system has some advantages compared to plain coverage scores:
Aeven if you "only" get 90 out of 100 possible points.
Bis basically good enough.
The last point might be the most important one: If objects are undocumented, there is nothing to evaluate. Therefore you can not simply give them a bad rating, because they might be left undocumented intentionally.
Inch does not give you a grade for your whole codebase. The grade distribution does a much better job of painting the bigger picture.
Every class, module and function in a codebase is assigned a priority which reflects how important Inch thinks it is to be documented.
This process follows some reasonable rules, like
Priorities are displayed as arrows. Arrows pointing north mark high priority objects, arrows pointing south mark low priority objects.