Resolve a few issues with JSDoc HTML

vaucouleur · Feb 15, 2016 · 7e97888 · 7e97888
1 parent 84e6be6
commit 7e97888
Show file tree

Hide file tree

Showing 18 changed files with 18 additions and 18 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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