File tree Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Original file line number Diff line number Diff line change @@ -58,6 +58,21 @@ documentation.
58
58
makes it possible to require documentation as part of your linting step,
59
59
ensuring that new code doesn't lower documentation coverage.
60
60
61
+ ## Which files does documentation.js include?
62
+
63
+ By default, ` documentation.js ` follows dependencies within your source tree
64
+ and excludes ` node_modules ` from results. This is meant to include your application
65
+ code automatically but avoid documenting the random npm modules you're
66
+ using.
67
+
68
+ This means that if you point ` documentation.js ` at your ` index.js ` file and
69
+ that file uses ` require ` or ` import ` to include other source files,
70
+ those source files will be documented too.
71
+
72
+ You can customize this behavior by specifying the ` --shallow ` command-line
73
+ option. With ` --shallow ` specified, dependendencies aren't followed: documentation.js
74
+ documents only the files you explicitly name.
75
+
61
76
## Will adding JSDoc comments slow down my code?
62
77
63
78
The short answer is "no".
You can’t perform that action at this time.
0 commit comments