Permalink
Browse files

Add JSDoc plugin for tree-namespace.json

  • Loading branch information...
bre1470 committed Jun 18, 2018
1 parent 9b3a75a commit c4fcd507a39cadf50f36519944d8360ff9e6ab55
Showing with 615 additions and 1 deletion.
  1. +1 −1 .gitignore
  2. +31 −0 gulpfile.js
  3. +583 −0 tools/jsdoc/plugins/highcharts.namespace.js
View
@@ -37,7 +37,7 @@
/utils/samples/nightly/
tree.json
tree_namespace.json
tree-namespace.json
exporting-server/java/highcharts-export/highcharts-export-web/pom.xml.amazon
exporting-server/java/highcharts-export/highcharts-export-web/pom.xml.github
View
@@ -1133,6 +1133,35 @@ const jsdoc = () => {
.then(() => generateAPIDocs(optionsAPI));
};
/**
* Create additional JSON-based class references from JSDOC
*/
const jsdocNamespace = () => {
const jsdoc3 = require('gulp-jsdoc3');
const gulpOptions = [[
'./code/highcharts.src.js'
], {
read: false
}],
jsdoc3Options = {
plugins: [
'./tools/jsdoc/plugins/highcharts.namespace'
]
};
const aGulp = (resolve, reject) => {
gulp.src(...gulpOptions).pipe(jsdoc3(jsdoc3Options,
(error) => {
if (error) {
reject(error);
} else {
resolve('done');
}
}
));
};
return new Promise(aGulp);
};
gulp.task('start-api-server', startServer);
gulp.task('upload-api', uploadAPIDocs);
gulp.task('create-productjs', createProductJS);
@@ -1143,6 +1172,8 @@ gulp.task('copy-to-dist', copyToDist);
gulp.task('filesize', filesize);
gulp.task('jsdoc', jsdoc);
gulp.task('styles', styles);
gulp.task('jsdoc-namespace', ['scripts'], jsdocNamespace);
// gulp.task('tsd', ['jsdoc-namespace'], require('highcharts-typescript-generator').task);
/**
* Gulp task to run the building process of distribution files. By default it
Oops, something went wrong.

0 comments on commit c4fcd50

Please sign in to comment.