Skip to content

Commit

Permalink
* Fixing documentation of global members with explicit annotation.
Browse files Browse the repository at this point in the history
* Ensure `elasticRadius` is documented as part of `BubbleMixin`.
  • Loading branch information
kum-deepak authored and gordonwoodhull committed Apr 7, 2020
1 parent 4803c4d commit 34474b2
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/base/bubble-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ export const BubbleMixin = Base => class extends ColorMixin(Base) {
/**
* Turn on or off the elastic bubble radius feature, or return the value of the flag. If this
* feature is turned on, then bubble radii will be automatically rescaled to fit the chart better.
* @memberof BubbleMixin
* @instance
* @param {Boolean} [elasticRadius=false]
* @returns {Boolean|BubbleChart}
*/
Expand Down
8 changes: 8 additions & 0 deletions src/core/chart-registry.js
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ export const chartRegistry = new ChartRegistry();
/**
* Add given chart instance to the given group, creating the group if necessary.
* If no group is provided, the default group `constants.DEFAULT_CHART_GROUP` will be used.
* @function registerChart
* @param {Object} chart dc.js chart instance
* @param {String} [group] Group name
* @return {undefined}
Expand All @@ -119,6 +120,7 @@ export const registerChart = function (chart, group) {
/**
* Remove given chart instance from the given group, creating the group if necessary.
* If no group is provided, the default group `constants.DEFAULT_CHART_GROUP` will be used.
* @function deregisterChart
* @param {Object} chart dc.js chart instance
* @param {String} [group] Group name
* @return {undefined}
Expand All @@ -129,6 +131,7 @@ export const deregisterChart = function (chart, group) {

/**
* Determine if a given chart instance resides in any group in the registry.
* @function hasChart
* @param {Object} chart dc.js chart instance
* @returns {Boolean}
*/
Expand All @@ -138,6 +141,7 @@ export const hasChart = function (chart) {

/**
* Clear given group if one is provided, otherwise clears all groups.
* @function deregisterAllCharts
* @param {String} group Group name
* @return {undefined}
*/
Expand All @@ -148,6 +152,7 @@ export const deregisterAllCharts = function (group) {
/**
* Clear all filters on all charts within the given chart group. If the chart group is not given then
* only charts that belong to the default chart group will be reset.
* @function filterAll
* @param {String} [group]
* @return {undefined}
*/
Expand All @@ -161,6 +166,7 @@ export const filterAll = function (group) {
/**
* Reset zoom level / focus on all charts that belong to the given chart group. If the chart group is
* not given then only charts that belong to the default chart group will be reset.
* @function refocusAll
* @param {String} [group]
* @return {undefined}
*/
Expand All @@ -176,6 +182,7 @@ export const refocusAll = function (group) {
/**
* Re-render all charts belong to the given chart group. If the chart group is not given then only
* charts that belong to the default chart group will be re-rendered.
* @function renderAll
* @param {String} [group]
* @return {undefined}
*/
Expand All @@ -195,6 +202,7 @@ export const renderAll = function (group) {
* that belong to the default chart group will be re-drawn. Redraw is different from re-render since
* when redrawing dc tries to update the graphic incrementally, using transitions, instead of starting
* from scratch.
* @function redrawAll
* @param {String} [group]
* @return {undefined}
*/
Expand Down
1 change: 1 addition & 0 deletions src/core/core.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {config} from './config';
* ({@link disableTransitions} is false) and the duration is greater than zero; otherwise return
* the selection. Since most operations are the same on a d3 selection and a d3 transition, this
* allows a common code path for both cases.
* @function transition
* @param {d3.selection} selection - the selection to be transitioned
* @param {Number|Function} [duration=250] - the duration of the transition in milliseconds, a
* function returning the duration, or 0 for no transition
Expand Down
1 change: 1 addition & 0 deletions src/core/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import {config} from './config';
* return this.radius + x;
* });
* selectAll('.circle').data(...).x(xPosition);
* @function pluck
* @param {String} n
* @param {Function} [f]
* @returns {Function}
Expand Down

0 comments on commit 34474b2

Please # to comment.