Skip to content

Update jsdoc libraries #363

Closed
Closed
@wooldridge

Description

@wooldridge

The modules that handle the documentation generation (jsdoc and gulp-jsdoc) are out of date. The gulp-jsdoc library is no longer being maintained so we need to move to gulp-jsdoc3.

The use of these out-of-date libraries is also causing deprecation warnings during npm install since they use outdated subdependencies.

We need to update to the following:

jsdoc 3.3.0-beta1 ==> jsdoc 3.4.3
gulp-jsdoc 0.1.4  ==> gulp-jsdoc3 1.0.1

The gulp-jsdoc3 API is different than the API for what we currently use, gulp-jsdoc. During a quick try with gulp-jsdoc3 (where I updated the methods), I was able to get docs to generate. But the docs didn't have the same styling, docs were generated for at least one method that should be ignored, and the doc files went into a default "out" directory rather than "doc". In a nutshell: more work needs to be done to get docs generated appropriately using the updated modules and the current config settings.

I will take another pass at this and then review with @jmakeig and @kcoleman-marklogic.

This issue came out of #343.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions