Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JSDoc HTML output and fix JSDoc tags #1086

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ module.exports = function (grunt) {
watch: {
jsdoc2md: {
files: ['<%= conf.src %>/**/*.js'],
tasks: ['build', 'jsdoc2md']
tasks: ['build', 'jsdoc', 'jsdoc2md']
},
scripts: {
files: ['<%= conf.src %>/**/*.js', '<%= conf.web %>/stock.js'],
Expand Down Expand Up @@ -211,6 +211,16 @@ module.exports = function (grunt) {
}
}
},
jsdoc: {
dist: {
src: 'dc.js',
options: {
destination: 'web/docs/html',
template: 'node_modules/ink-docstrap/template',
configure: 'node_modules/ink-docstrap/template/jsdoc.conf.json'
}
}
},
jsdoc2md: {
dist: {
src: 'dc.js',
Expand Down Expand Up @@ -374,7 +384,7 @@ module.exports = function (grunt) {

// task aliases
grunt.registerTask('build', ['concat', 'uglify', 'cssmin']);
grunt.registerTask('docs', ['build', 'copy', 'jsdoc2md', 'docco', 'fileindex']);
grunt.registerTask('docs', ['build', 'copy', 'jsdoc', 'jsdoc2md', 'docco', 'fileindex']);
grunt.registerTask('web', ['docs', 'gh-pages']);
grunt.registerTask('server', ['docs', 'fileindex', 'jasmine:specs:build', 'connect:server', 'watch:jasmine-docs']);
grunt.registerTask('test', ['build', 'jasmine:specs']);
Expand All @@ -384,7 +394,7 @@ module.exports = function (grunt) {
grunt.registerTask('ci-pull', ['test', 'jasmine:specs:build', 'connect:server']);
grunt.registerTask('lint', ['jshint', 'jscs']);
grunt.registerTask('default', ['build', 'shell:hooks']);
grunt.registerTask('jsdoc', ['build', 'jsdoc2md', 'watch:jsdoc2md']);
grunt.registerTask('doc-debug', ['build', 'jsdoc', 'jsdoc2md', 'watch:jsdoc2md']);
};

module.exports.jsFiles = [
Expand Down
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,14 @@
"grunt-fileindex": "^0.1.0",
"grunt-gh-pages": "~0.10.0",
"grunt-jscs": "~2.1.0",
"grunt-jsdoc": "~1.1.0",
"grunt-jsdoc-to-markdown": "~1.1.1",
"grunt-lib-phantomjs": "~0.7.1",
"grunt-markdown": "~0.7.0",
"grunt-saucelabs": "~8.6.1",
"grunt-shell": "~1.1.1",
"grunt-template-jasmine-istanbul": "~0.3.2",
"ink-docstrap": "~1.1.0",
"jsdifflib": "~1.1.0",
"load-grunt-tasks": "~3.2.0",
"marked": "~0.3.3",
Expand Down
12 changes: 6 additions & 6 deletions src/bar-chart.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}
* @name barChart
* @namespace barChart
* @memberof dc
* @mixes dc.stackMixin
* @mixes dc.coordinateGridMixin
Expand Down Expand Up @@ -227,7 +227,7 @@ dc.barChart = function (parent, chartGroup) {

/**
* Whether the bar chart will render each bar centered around the data position on the x-axis.
* @name centerBar
* @method centerBar
* @memberof dc.barChart
* @instance
* @param {Boolean} [centerBar=false]
Expand All @@ -251,7 +251,7 @@ dc.barChart = function (parent, chartGroup) {
* Setting this value will also remove any previously set {@link #dc.barChart+gap gap}. See the
* {@link https://github.com/mbostock/d3/wiki/Ordinal-Scales#wiki-ordinal_rangeBands d3 docs}
* for a visual description of how the padding is applied.
* @name barPadding
* @method barPadding
* @memberof dc.barChart
* @instance
* @param {Number} [barPadding=0]
Expand All @@ -274,7 +274,7 @@ dc.barChart = function (parent, chartGroup) {
/**
* Get or set the outer padding on an ordinal bar chart. This setting has no effect on non-ordinal charts.
* Will pad the width by `padding * barWidth` on each side of the chart.
* @name outerPadding
* @method outerPadding
* @memberof dc.barChart
* @instance
* @param {Number} [padding=0.5]
Expand All @@ -287,7 +287,7 @@ dc.barChart = function (parent, chartGroup) {
* Manually set fixed gap (in px) between bars instead of relying on the default auto-generated
* gap. By default the bar chart implementation will calculate and set the gap automatically
* based on the number of data points and the length of the x axis.
* @name gap
* @method gap
* @memberof dc.barChart
* @instance
* @param {Number} [gap=2]
Expand Down Expand Up @@ -322,7 +322,7 @@ dc.barChart = function (parent, chartGroup) {
* When using standard d3.js rounding methods, the brush often doesn't align correctly with
* centered bars since the bars are offset. The rounding function must add an offset to
* compensate, such as in the following example.
* @name alwaysUseRounding
* @method alwaysUseRounding
* @memberof dc.barChart
* @instance
* @example
Expand Down
Loading