From 3a33793f64739b7c41c1b8a61e84ea9a02c807b3 Mon Sep 17 00:00:00 2001 From: Ben McCann <322311+benmccann@users.noreply.github.com> Date: Fri, 8 Nov 2019 04:28:21 -0800 Subject: [PATCH] Generate jsdocs (#5824) --- docs/SUMMARY.md | 1 + docs/developers/plugins.md | 29 +++-------------------------- gulpfile.js | 19 ++++++++++++++++--- package.json | 1 + 4 files changed, 21 insertions(+), 29 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 088ea6343..98e388cdf 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -47,6 +47,7 @@ * [Styling](axes/styling.md) * [Developers](developers/README.md) * [Chart.js API](developers/api.md) + * [JSDoc](jsdoc/index.html) * [Updating Charts](developers/updates.md) * [Plugins](developers/plugins.md) * [New Charts](developers/charts.md) diff --git a/docs/developers/plugins.md b/docs/developers/plugins.md index a935fe2fe..edc353f3a 100644 --- a/docs/developers/plugins.md +++ b/docs/developers/plugins.md @@ -104,29 +104,6 @@ var chart = new Chart(ctx, { }); ``` -## Plugin Core API - -Available hooks (as of version 2.7): - -* `beforeInit` -* `afterInit` -* `beforeUpdate` *(cancellable)* -* `afterUpdate` -* `beforeLayout` *(cancellable)* -* `afterLayout` -* `beforeDatasetsUpdate` *(cancellable)* -* `afterDatasetsUpdate` -* `beforeDatasetUpdate` *(cancellable)* -* `afterDatasetUpdate` -* `beforeRender` *(cancellable)* -* `afterRender` -* `beforeDraw` *(cancellable)* -* `afterDraw` -* `beforeDatasetsDraw` *(cancellable)* -* `afterDatasetsDraw` -* `beforeDatasetDraw` *(cancellable)* -* `afterDatasetDraw` -* `beforeEvent` *(cancellable)* -* `afterEvent` -* `resize` -* `destroy` + ## Plugin Core API + +Read more about the [existing plugin extension hooks](../jsdoc/IPlugin.html). diff --git a/gulpfile.js b/gulpfile.js index 23b44af17..7ce62447a 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -1,6 +1,7 @@ var gulp = require('gulp'); var eslint = require('gulp-eslint'); var file = require('gulp-file'); +var jsdoc = require('gulp-jsdoc3'); var replace = require('gulp-replace'); var size = require('gulp-size'); var streamify = require('gulp-streamify'); @@ -130,12 +131,24 @@ function lintHtmlTask() { })); } -function docsTask() { - var bin = 'gitbook-cli/bin/gitbook.js'; +function docsTask(done) { + var bin = require.resolve('gitbook-cli/bin/gitbook.js'); var cmd = argv.watch ? 'serve' : 'build'; return run(bin, ['install', './']) - .then(() => run(bin, [cmd, './', './dist/docs'])); + .then(() => run(bin, [cmd, './', './dist/docs'])) + .then(() => { + var config = { + opts: { + destination: './dist/docs/jsdoc' + }, + recurse: true + }; + gulp.src(['./src/**/*.js'], {read: false}) + .pipe(jsdoc(config, done)); + }).catch((err) => { + done(new Error(err.stdout || err)); + }); } function unittestTask(done) { diff --git a/package.json b/package.json index fd9e73277..5a6f4eb1a 100644 --- a/package.json +++ b/package.json @@ -43,6 +43,7 @@ "gulp-eslint": "^6.0.0", "gulp-file": "^0.4.0", "gulp-htmllint": "^0.0.16", + "gulp-jsdoc3": "^2.0.0", "gulp-replace": "^1.0.0", "gulp-size": "^3.0.0", "gulp-streamify": "^1.0.2", -- 2.47.2