Skip to content

Commit 53d9108

Browse files
author
Jae Sung Park
committed
docs(all): Fix jsdoc lint warnings
fix "jsdoc/reject-function-type" warnings
1 parent 4fad425 commit 53d9108

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+152
-152
lines changed

src/Chart/api/chart.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,10 +165,10 @@ export default {
165165
* @instance
166166
* @memberof Chart
167167
* @param {string} name The option key name.
168-
* @param {*} [value] The value accepted for indicated option.
168+
* @param {string|number|boolean|object|Array} [value] The value accepted for indicated option.
169169
* @param {boolean} [redraw] Set to redraw with the new option changes.
170170
* - **NOTE:** Doesn't guarantee work in all circumstances. It can be applied for limited options only.
171-
* @returns {*}
171+
* @returns {string|number|boolean|object|Array} The option value or all options object
172172
* @example
173173
*
174174
* // Getter

src/Chart/api/export.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ export default {
231231
* - Text element's position(especially "transformed") can't be preserved correctly according the page's layout condition.
232232
* - If need to preserve accurate text position, embed the web font data within to the page and set `preserveFontStyle=false`.
233233
* - Checkout the embed example: <a href="https://stackblitz.com/edit/zfbya9-8nf9nn?file=index.html">https://stackblitz.com/edit/zfbya9-8nf9nn?file=index.html</a>
234-
* @param {Function} [callback] The callback to be invoked when export is ready.
234+
* @param {function(string): void} [callback] The callback to be invoked when export is ready.
235235
* @returns {string} dataURI
236236
* @example
237237
* chart.export();

src/ChartInternal/Axis/AxisRendererHelper.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export default class AxisRendererHelper {
7272
/**
7373
* Get tick transform setter function
7474
* @param {string} id Axis id
75-
* @returns {Function} transfrom setter function
75+
* @returns {(selection: d3Selection, scale) => void} transfrom setter function
7676
* @private
7777
*/
7878
getTickTransformSetter(id: string): (selection: d3Selection, scale) => void {

src/ChartInternal/data/convert.helper.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ function json(json, keysParam) {
152152
* @param {string} mimeType MIME type string: json | csv | tsv
153153
* @param {object} headers Header object
154154
* @param {object} keys Key object
155-
* @param {Function} done Callback function
155+
* @param {function} done Callback function
156156
* @private
157157
*/
158158
function url(url: string, mimeType = "csv", headers: object, keys: object, done: Function): void {

src/ChartInternal/data/convert.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ export default {
9595
/**
9696
* Convert data according its type
9797
* @param {object} args data object
98-
* @param {Function} [callback] callback for url(XHR) type loading
98+
* @param {function} [callback] callback for url(XHR) type loading
9999
* @private
100100
*/
101101
convertData(args, callback: Function): void {

src/ChartInternal/data/data.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -620,7 +620,7 @@ export default {
620620
/**
621621
* Get data.order compare function
622622
* @param {boolean} isReversed for Arc & Treemap type sort order needs to be reversed
623-
* @returns {Function} compare function
623+
* @returns {function} compare function
624624
* @private
625625
*/
626626
getSortCompareFn(isReversed = false): Function | null {

src/ChartInternal/data/load.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {endall} from "../../module/util";
77

88
/**
99
* Call done callback with resize after transition
10-
* @param {Function} fn Callback function
10+
* @param {function} fn Callback function
1111
* @param {boolean} resizeAfter Weather to resize chart after the load
1212
* @private
1313
*/

src/ChartInternal/interactions/flow.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export default {
1111
/**
1212
* Generate flow
1313
* @param {object} args option object
14-
* @returns {Function}
14+
* @returns {function}
1515
* @private
1616
*/
1717
generateFlow(args): Function {

src/ChartInternal/interactions/interaction.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ export default {
149149

150150
/**
151151
* Return draggable selection function
152-
* @returns {Function}
152+
* @returns {function}
153153
* @private
154154
*/
155155
getDraggableSelection(): Function {

src/ChartInternal/interactions/zoom.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ export default {
309309

310310
/**
311311
* Set zoom transform to event rect
312-
* @param {Function} x x Axis scale function
312+
* @param {function} x x Axis scale function
313313
* @param {Array} domain Domain value to be set
314314
* @private
315315
*/

0 commit comments

Comments
 (0)