Generate jsdocs (#5824)

diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index 088ea6343cf423b69a93605bdf9e05608f53f582..98e388cdf6a66c56c4d752eea126a689c5be6433 100644 (file)
--- 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 a935fe2fe74420864adbfa9c59cf3dd2907400a0..edc353f3afd9b1318f88afda0c2ae9357a44c39f 100644 (file)
--- 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 23b44af1718cd90ea001df74c4d6956f40db4e8e..7ce62447a265164fbe2ca51b04254081263105d0 100644 (file)
--- 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 fd9e73277b67c2b2f32b80f00ac87889a88ed8c3..5a6f4eb1abd9341133c193f9eae14933f68f5640 100644 (file)
--- 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",