CODEWITHSUNDEEP
javascriptnode.jsjsdocjsdoc3
Grepped
Grepped

Reputation: 21

How to separate JSDoc by file/module

When I generate docs, it places all of the function documentation within one file.

Other than invoking JSDoc multiple times for each file and then renaming, is there a way to separate the docs using a tag or flag?

Upvotes: 2

Views: 2475

Answers (2)

Slava Ivanov
Slava Ivanov

Reputation: 6912

You are probably generate the documentation per file basis. This is configurable via Command-line arguments to JSDoc or by Configuring JSDoc with conf.json. You are able to specify directory, where your JS files are located and/or separate files to be included and excluded.

Upvotes: 2

user20187265
user20187265

Reputation:

The links in the previous answer were broken, so what I found worked was using the @module tag at the top of each file, and then using a jsdoc.json with opts/recurse: true.

Upvotes: 1

Related Questions