jsdoc / jsdoc

An API documentation generator for JavaScript.
https://jsdoc.app/
Apache License 2.0
15.07k stars 1.45k forks source link

Need More robust ways to exclude multiple directories, paths, and/or files #300

Closed joshrhoades closed 11 years ago

joshrhoades commented 11 years ago

./jsdoc --help shows no way to set ignore of directories, whereas jsdoc-toolkit provided for the -nocode flag (only documenting anything with an @name, though I didn't find this as useful as the ability to ignore directories, or at the very least set a recursion depth (though, again, recursion depth is more useful if you can set explicit directories/paths to ignore)).

I keep getting java.lang.OutOfMemoryError: Java heap space errors when running against an entire solution (on a latest gen MBP that is maxed out), since there is a lot to recurse in the entire solution (some of which I want to flat out ignore, such as 3rd party libraries). The addition of this ability would add a lot of flexibility...unless I'm missing something in --help or the sparse documentation that provides for this.

The excludePattern handles this somewhat, but its more problematic for multiple directories, files, and/or patterns to exclude.

joshrhoades commented 11 years ago

Bah, nevermind, I tried something else with the excludePatterns and looks like I got it. Sorry for the confusion (I swear I thought I tried everything before posting...but there's always one last trick).

hegemonic commented 11 years ago

Glad things worked out!

heyandresdjc commented 4 years ago

care to share the solution thanks