Search code examples
rubydocumentationdocumentation-generationyard

How can I list the undocumented modules/classes/constants/methods with yardoc?

I have a small library of code that I am documenting with YARD. When I run the yardoc command, it tells me:

Files:          40
Modules:        14 (    0 undocumented)
Classes:        39 (    0 undocumented)
Constants:      21 (    4 undocumented)
Methods:       239 (   31 undocumented)
 88.82% documented

Instead of wading through all of my code to find the undocumented constants and methods, I want it to simply list the undocumented items. Anybody know how to do this?

Solution

  • You can specifically list all undocumented objects (and their file locations) with the --list-undoc option.

    yard stats --list-undoc

    or even

    yard --list-undoc