From e1344b6e454cec69d0ca154087679e54082123ba Mon Sep 17 00:00:00 2001 From: Gordon Woodhull Date: Thu, 11 Feb 2016 23:20:27 -0500 Subject: [PATCH 1/3] paren --- Changelog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Changelog.md b/Changelog.md index 99a133198..ae8721b1d 100644 --- a/Changelog.md +++ b/Changelog.md @@ -2,7 +2,7 @@ ## 2.0.0 beta 26 * Apply pie chart labels before transition, so they are easier to manipulate with the pretransition hook. Added example of showing percentages in pie chart labels. (Workaround for [#703](https://github.com/dc-js/dc.js/issues/703)) * Documentation of chart registry, by Jasmine Hegman ([#676](https://github.com/dc-js/dc.js/issues/676) / [#1082](https://github.com/dc-js/dc.js/pull/1082)) -* HTML documentation generation, by Matt Traynham. There are still some kinks to be worked out here, but in principle it should be more robust than the gigantic markdown file we are generating. ([#1086](https://github.com/dc-js/dc.js/pull/1086) +* HTML documentation generation, by Matt Traynham. There are still some kinks to be worked out here, but in principle it should be more robust than the gigantic markdown file we are generating. ([#1086](https://github.com/dc-js/dc.js/pull/1086)) * Document that you need to use a `RangedFilter` when filtering a range, by koefoed ([#1090](https://github.com/dc-js/dc.js/pull/1090)) * Fix links to box plot examples, by Yuval Greenfield ([#1094](https://github.com/dc-js/dc.js/pull/1094)) * [Sparkline example](http://dc-js.github.io/dc.js/examples/sparkline.html) ([#1013](https://github.com/dc-js/dc.js/issues/1013)) From 84e6be66cee6d90cbd074e0acf090d7902b74702 Mon Sep 17 00:00:00 2001 From: Gordon Woodhull Date: Fri, 12 Feb 2016 18:04:34 -0500 Subject: [PATCH 2/3] use jsdoc.conf.json for #1086 --- Gruntfile.js | 2 +- jsdoc.conf.json | 28 ++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 jsdoc.conf.json diff --git a/Gruntfile.js b/Gruntfile.js index 10c9a96fc..f668138bb 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -220,7 +220,7 @@ module.exports = function (grunt) { options: { destination: 'web/docs/html', template: 'node_modules/ink-docstrap/template', - configure: 'node_modules/ink-docstrap/template/jsdoc.conf.json' + configure: 'jsdoc.conf.json' } } }, diff --git a/jsdoc.conf.json b/jsdoc.conf.json new file mode 100644 index 000000000..b2060b56f --- /dev/null +++ b/jsdoc.conf.json @@ -0,0 +1,28 @@ +{ + "tags": { + "allowUnknownTags": true + }, + "plugins": ["plugins/markdown"], + "templates": { + "logoFile": "", + "cleverLinks": false, + "monospaceLinks": false, + "dateFormat": "ddd MMM Do YYYY", + "outputSourceFiles": true, + "outputSourcePath": true, + "systemName": "dc.js", + "footer": "", + "copyright": "dc.js Copyright © 2012-2016 Copyright 2012-2016 Nick Zhu & the dc.js Developers", + "navType": "vertical", + "theme": "cosmo", + "linenums": true, + "collapseSymbols": false, + "inverseNav": true, + "protocol": "html://", + "methodHeadingReturns": false + }, + "markdown": { + "parser": "gfm", + "hardwrap": true + } +} From 32269ab182dc5486a7b77c778658daa751f6d27c Mon Sep 17 00:00:00 2001 From: Matt Traynham Date: Fri, 12 Feb 2016 21:30:15 -0500 Subject: [PATCH 3/3] Resolve a few issues with JSDoc HTML --- Gruntfile.js | 2 +- src/bar-chart.js | 2 +- src/box-plot.js | 2 +- src/bubble-chart.js | 2 +- src/bubble-overlay.js | 2 +- src/composite-chart.js | 2 +- src/data-count.js | 2 +- src/data-grid.js | 2 +- src/data-table.js | 2 +- src/geo-choropleth-chart.js | 2 +- src/heatmap.js | 2 +- src/legend.js | 2 +- src/line-chart.js | 2 +- src/number-display.js | 2 +- src/pie-chart.js | 2 +- src/row-chart.js | 2 +- src/scatter-plot.js | 2 +- src/series-chart.js | 2 +- 18 files changed, 18 insertions(+), 18 deletions(-) diff --git a/Gruntfile.js b/Gruntfile.js index f668138bb..331cae135 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -216,7 +216,7 @@ module.exports = function (grunt) { }, jsdoc: { dist: { - src: 'dc.js', + src: ['<%= conf.src %>/**/*.js', '!<%= conf.src %>/{banner,footer}.js'], options: { destination: 'web/docs/html', template: 'node_modules/ink-docstrap/template', diff --git a/src/bar-chart.js b/src/bar-chart.js index 8f3a6c434..a239ae3db 100644 --- a/src/bar-chart.js +++ b/src/bar-chart.js @@ -4,7 +4,7 @@ * Examples: * - {@link http://dc-js.github.com/dc.js/ Nasdaq 100 Index} * - {@link http://dc-js.github.com/dc.js/crime/index.html Canadian City Crime Stats} - * @namespace barChart + * @class barChart * @memberof dc * @mixes dc.stackMixin * @mixes dc.coordinateGridMixin diff --git a/src/box-plot.js b/src/box-plot.js index c20273216..612c6127a 100644 --- a/src/box-plot.js +++ b/src/box-plot.js @@ -4,7 +4,7 @@ * Examples: * - {@link http://dc-js.github.io/dc.js/examples/box-plot-time.html Box plot time example} * - {@link http://dc-js.github.io/dc.js/examples/box-plot.html Box plot example} - * @namespace boxPlot + * @class boxPlot * @memberof dc * @mixes dc.coordinateGridMixin * @example diff --git a/src/bubble-chart.js b/src/bubble-chart.js index dabe86eb3..e4b82e20d 100644 --- a/src/bubble-chart.js +++ b/src/bubble-chart.js @@ -9,7 +9,7 @@ * Examples: * - {@link http://dc-js.github.com/dc.js/ Nasdaq 100 Index} * - {@link http://dc-js.github.com/dc.js/vc/index.html US Venture Capital Landscape 2011} - * @namespace bubbleChart + * @class bubbleChart * @memberof dc * @mixes dc.bubbleMixin * @mixes dc.coordinateGridMixin diff --git a/src/bubble-overlay.js b/src/bubble-overlay.js index 19100b86a..901afb0f5 100644 --- a/src/bubble-overlay.js +++ b/src/bubble-overlay.js @@ -6,7 +6,7 @@ * * Examples: * - {@link http://dc-js.github.com/dc.js/crime/index.html Canadian City Crime Stats} - * @namespace bubbleOverlay + * @class bubbleOverlay * @memberof dc * @mixes dc.bubbleMixin * @mixes dc.baseMixin diff --git a/src/composite-chart.js b/src/composite-chart.js index fc321b13f..b9e9c5d76 100644 --- a/src/composite-chart.js +++ b/src/composite-chart.js @@ -2,7 +2,7 @@ * Composite charts are a special kind of chart that render multiple charts on the same Coordinate * Grid. You can overlay (compose) different bar/line/area charts in a single composite chart to * achieve some quite flexible charting effects. - * @namespace compositeChart + * @class compositeChart * @memberof dc * @mixes dc.coordinateGridMixin * @example diff --git a/src/data-count.js b/src/data-count.js index 42b5c2b1a..f645ea381 100644 --- a/src/data-count.js +++ b/src/data-count.js @@ -8,7 +8,7 @@ * * Examples: * - {@link http://dc-js.github.com/dc.js/ Nasdaq 100 Index} - * @namespace dataCount + * @class dataCount * @memberof dc * @mixes dc.baseMixin * @example diff --git a/src/data-grid.js b/src/data-grid.js index 1d9efe216..8e5b321c4 100644 --- a/src/data-grid.js +++ b/src/data-grid.js @@ -8,7 +8,7 @@ * * Examples: * - {@link http://europarl.me/dc.js/web/ep/index.html List of members of the european parliament} - * @namespace dataGrid + * @class dataGrid * @memberof dc * @mixes dc.baseMixin * @param {String|node|d3.selection} parent - Any valid diff --git a/src/data-table.js b/src/data-table.js index 4f9b329f2..2761d00aa 100644 --- a/src/data-table.js +++ b/src/data-table.js @@ -15,7 +15,7 @@ * - {@link http://dc-js.github.com/dc.js/ Nasdaq 100 Index} * - {@link http://dc-js.github.io/dc.js/examples/table-on-aggregated-data.html dataTable on a crossfilter group} * ({@link https://github.com/dc-js/dc.js/blob/develop/web/examples/table-on-aggregated-data.html source}) - * @namespace dataTable + * @class dataTable * @memberof dc * @mixes dc.baseMixin * @param {String|node|d3.selection} parent - Any valid diff --git a/src/geo-choropleth-chart.js b/src/geo-choropleth-chart.js index 46d11ba2b..3afd0307a 100644 --- a/src/geo-choropleth-chart.js +++ b/src/geo-choropleth-chart.js @@ -5,7 +5,7 @@ * * Examples: * - {@link http://dc-js.github.com/dc.js/vc/index.html US Venture Capital Landscape 2011} - * @namespace geoChoroplethChart + * @class geoChoroplethChart * @memberof dc * @mixes dc.colorMixin * @mixes dc.baseMixin diff --git a/src/heatmap.js b/src/heatmap.js index 50c653f47..cd89d7cb9 100644 --- a/src/heatmap.js +++ b/src/heatmap.js @@ -1,6 +1,6 @@ /** * A heat map is matrix that represents the values of two dimensions of data using colors. - * @namespace heatMap + * @class heatMap * @memberof dc * @mixes dc.colorMixin * @mixes dc.marginMixin diff --git a/src/legend.js b/src/legend.js index aec6beca2..5932e3c6c 100644 --- a/src/legend.js +++ b/src/legend.js @@ -5,7 +5,7 @@ * Examples: * - {@link http://dc-js.github.com/dc.js/ Nasdaq 100 Index} * - {@link http://dc-js.github.com/dc.js/crime/index.html Canadian City Crime Stats} - * @namespace legend + * @class legend * @memberof dc * @example * chart.legend(dc.legend().x(400).y(10).itemHeight(13).gap(5)) diff --git a/src/line-chart.js b/src/line-chart.js index 16bd5e75e..f0bf120c6 100644 --- a/src/line-chart.js +++ b/src/line-chart.js @@ -4,7 +4,7 @@ * Examples: * - {@link http://dc-js.github.com/dc.js/ Nasdaq 100 Index} * - {@link http://dc-js.github.com/dc.js/crime/index.html Canadian City Crime Stats} - * @namespace lineChart + * @class lineChart * @memberof dc * @mixes dc.stackMixin * @mixes dc.coordinateGridMixin diff --git a/src/number-display.js b/src/number-display.js index 0aa351e83..be3191728 100644 --- a/src/number-display.js +++ b/src/number-display.js @@ -2,7 +2,7 @@ * A display of a single numeric value. * Unlike other charts, you do not need to set a dimension. Instead a group object must be provided and * a valueAccessor that returns a single value. - * @namespace numberDisplay + * @class numberDisplay * @memberof dc * @mixes dc.baseMixin * @example diff --git a/src/pie-chart.js b/src/pie-chart.js index 25741a9a4..675b5f9c3 100644 --- a/src/pie-chart.js +++ b/src/pie-chart.js @@ -6,7 +6,7 @@ * * Examples: * - {@link http://dc-js.github.com/dc.js/ Nasdaq 100 Index} - * @namespace pieChart + * @class pieChart * @memberof dc * @mixes dc.capMixin * @mixes dc.colorMixin diff --git a/src/row-chart.js b/src/row-chart.js index 47bac4459..699338e43 100644 --- a/src/row-chart.js +++ b/src/row-chart.js @@ -3,7 +3,7 @@ * * Examples: * - {@link http://dc-js.github.com/dc.js/ Nasdaq 100 Index} - * @namespace rowChart + * @class rowChart * @memberof dc * @mixes dc.capMixin * @mixes dc.marginMixin diff --git a/src/scatter-plot.js b/src/scatter-plot.js index f03fc628f..95ca7625a 100644 --- a/src/scatter-plot.js +++ b/src/scatter-plot.js @@ -4,7 +4,7 @@ * Examples: * - {@link http://dc-js.github.io/dc.js/examples/scatter.html Scatter Chart} * - {@link http://dc-js.github.io/dc.js/examples/multi-scatter.html Multi-Scatter Chart} - * @namespace scatterPlot + * @class scatterPlot * @memberof dc * @mixes dc.coordinateGridMixin * @example diff --git a/src/series-chart.js b/src/series-chart.js index 0f9837a68..28cc3b3de 100644 --- a/src/series-chart.js +++ b/src/series-chart.js @@ -5,7 +5,7 @@ * * Examples: * - {@link http://dc-js.github.io/dc.js/examples/series.html Series Chart} - * @namespace seriesChart + * @class seriesChart * @memberof dc * @mixes dc.compositeChart * @example