Skip to content

Commit 0c3f178

Browse files
arvtmcw
authored andcommitted
Update docs for which files are included (#548)
* Update docs for which files are included * Copyedits * More copyedits
1 parent 16da8bb commit 0c3f178

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/FAQ.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ You can customize this behavior by specifying the `--shallow` command-line
7373
option. With `--shallow` specified, dependendencies aren't followed: documentation.js
7474
documents only the files you explicitly name.
7575

76+
If you're using ES modules, you enable the option `--document-exported` to automatically
77+
document all exported bindings in your project, even if they don't have JSDoc comments.
78+
This also ignores non-exported items, even if they are commented.
79+
7680
## Will adding JSDoc comments slow down my code?
7781

7882
The short answer is "no".

0 commit comments

Comments
 (0)