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

Question

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?

score 51 · Accepted Answer · edited Jul 20 '15 at 20:34

51

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

edited Jul 20 '15 at 20:34

matb

851
13
23

answered Apr 22 '11 at 16:00

Vasiliy Ermolovich

24,459
5
79
77

Nice! That option wasn't listed in the `--help` output, and when I used it, yardoc said `[warn]: Unrecognized/invalid option: --list-undoc` -- but it worked anyway. Thanks! – Jeff Terrell Ph.D. Apr 25 '11 at 18:08
This should not be the accepted answer. @Asher's is more correct. – Aug 14 '12 at 15:12
Thanks, I've update the answer. But, Jeff, feel free to re-accept the answer if you want. – Vasiliy Ermolovich Aug 14 '12 at 19:01

score 27 · Answer 2 · edited Jun 25 '12 at 05:55

27

This confused me as well. The --list-undoc option is actually defined under the stats command. Also, the command is yard rather than yardoc, which is shorthand for yard doc.

yard stats --list-undoc

edited Jun 25 '12 at 05:55

Asher

1,195
1
11
19

answered May 21 '11 at 02:34

postmodern

271
2
2

1

For reference, it's actually "yard stats --list-undoc" rather than yardoc. – Asher Jun 25 '12 at 05:27

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

2 Answers2