Open ojab opened 3 years ago
class Xxx def x puts 'xxx' end end
$ yard doc xxx.rb Files: 1 Modules: 0 ( 0 undocumented) Classes: 1 ( 1 undocumented) Constants: 0 ( 0 undocumented) Attributes: 0 ( 0 undocumented) Methods: 1 ( 1 undocumented) 0.00% documented $ yard doc --list-undoc xxx.rb [warn]: Unrecognized/invalid option: --list-undoc Files: 0 Modules: 0 ( 0 undocumented) Classes: 0 ( 0 undocumented) Constants: 0 ( 0 undocumented) Attributes: 0 ( 0 undocumented) Methods: 0 ( 0 undocumented) 100.00% documented $ yard doc --list-undoc --db .yardoc/ xxx.rb [warn]: Unrecognized/invalid option: --list-undoc Files: 1 Modules: 0 ( 0 undocumented) Classes: 1 ( 1 undocumented) Constants: 0 ( 0 undocumented) Attributes: 0 ( 0 undocumented) Methods: 1 ( 1 undocumented) 0.00% documented Undocumented Objects: (in file: xxx.rb) Xxx Xxx#x
I suppose db should be implicitly set and --list-undoc should be added to the list of supported options.
db
--list-undoc
ruby -v
yard -v
I have read the Contributing Guide.
--list-undoc is not supported in yard doc. That option is part of yard stats.
yard doc
yard stats
The command above worked due to internal behavior, but it is considered undefined behavior to use yard doc --list-undoc
yard doc --list-undoc
Steps to reproduce
I suppose
db
should be implicitly set and--list-undoc
should be added to the list of supported options.Environment details:
ruby -v
): ruby 3.0.1p64 (2021-04-05 revision 0fb782ee38) [x86_64-linux]yard -v
): yard 0.9.26I have read the Contributing Guide.