This extension allows a developer to view the jsdoc documentation for their current project within vscode (in a webview panel). This extension introduces two commands--
jsdocView.start, which will open up the jsdoc docs for this project (based on this extension's settings) and
jsdocView.generate which will (re)generate said jsdoc documentation (again based on other settings for this extension). If
jsdocView.start does not find any documentation in the specified place, it will attempt to generate them (via
This version of this extension also includes an experimental feature to lookup the current word in the editor within the jsdoc documents for the project via
docstrap's full text search facilities... Which works as far as it goes.
- Bring up a webview within vscode to display the jsdoc documentation for the current project.
- Generate the jsdoc documentation for your project from within vscode.
This extension assumes the presence of the
jsdoc module, although it doesn't call it directly. It does attempt to generate jsdoc documentation indirectly via an npm script (by default it assumes this script is called
npm run-script build-docs).
: Specifies the npm script to run in order to generate the documentation.
: The direction into which the documentation will be generated.
: Will cause the jsdocView processor to replace the
<meta Content-Source-Policy...> tag with one it thinks will allow more jsdoc sources to function.
: The actual content policy to insert into the generated html pages which get rendered by VSCode. Only used is
preprocessOptions.repaceCSP is true.
: This is the heart of the preprocessor's work specification, now made entirely configurable. This setting directs the preprocessor which tags to check which attributes for paths which may need fixing. As per heuristic analysis at this time, only schemeless relative paths are altered at this time. This setting is an object, each field of which represents a specific rule. Each rule allows for a short hand of
"tag-name" as the field index. You can also specify within the rule object itself a
selector. All the attributes listed in
attrs will be checked and replaced if matching. You can specify for a given rule that you only want tags with specific class decorators to be modified (
ifHasClass). You can also specify to explicitly skip tags with a specific class (
exceptHasClass). The latter has precedence. If
ifHasClass is specified, the default inclusion is false, otherwise it is true.