How to generate documentation from a set of files

[doberkofler]

I cannot seem to understand how to use the documentation CLI to specify a set of files.
In jsdoc I've used --recurse src/ods src/framework to process all JS files in the directories src/ods and src/framework recursively and I cannot see how this would be done in the documentation CLI.

[doberkofler]

I've just discovered (by trying) that it is possible to specify one or more directories by simply specifying the path with a path separator at the end ./src/framework/ but it does not seem to recurse into the sub-directories and I see no option to do so. How would this be done?

[robotmayo]

You can glob it. ./src/* will process all files in all subdirectories.

[Reinmar]

I've just stumbled upon this while I nearly rejected documentation.js for not being able to scan the tree recursively ;) In the docs I only found that it does it by checking dependencies (there's that --shallow option), so I thought that this is the only supported way of scanning the whole tree.

[arv]

I also added --document-exported a month or so back. If you are writing ES modules then this option might be better suited for you.

[tmcw]

I'm going to add examples to clear up this confusion by showing multiple ways of including files in documentation.

There's a separate issue - that a few shells, like Windows Powershell, don't support globs ( #335 ). I'm punting on that one because we don't have Windows CI and it's not super common.

[tmcw]

I ported eslint's solution in #629 and it'll be available in the next release: documentation.js itself will interpret glob patterns on Windows, making it cross-platform compatible, and it will automatically turn a reference to a directory into a recursive glob of that directory!