Skip to content

Commit a75e9cd

Browse files
committed
DM-7767 fixed jsdoc errors
1 parent 6c9e262 commit a75e9cd

File tree

3 files changed

+9
-12
lines changed

3 files changed

+9
-12
lines changed

src/firefly/js/core/ReduxFlux.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,10 @@ import {showExampleDialog} from '../ui/ExampleDialog.jsx';
9595

9696
/**
9797
* @typedef {Object} Action
98-
* @prop {String} type the action constant
99-
* @prop {Object} payload object with anything
98+
* @prop {String} type - the action constant, a unique string identifying this action
99+
* @prop {Object} payload - object with anything, the data
100+
* @global
101+
* @public
100102
*/
101103

102104

src/firefly/js/core/core-typedefs.jsdoc

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,6 @@
33
*/
44

55

6-
/**
7-
* @typedef {Object} Action
8-
* @prop {string} type a unique string identifying this action
9-
* @prop {Object} payload the data
10-
*/
11-
12-
136
/**
147
* Common Layout information used to control generic behavior, ie drop-down panel, expanded/collapsed state, etc
158
* The intention here is to allow additional layout attributes to be added to handle specific layout needs of a

src/firefly/js/visualize/DrawLayerCntlr.js

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -675,6 +675,7 @@ function deletePlotView(state,action, dlReducer) {
675675
return Object.assign({},state, {drawLayerAry});
676676
}
677677

678+
678679
function addTableToIgnore(state,action) {
679680
const {drawLayerTypeId,tableId}= action.payload;
680681
const {ignoreTables}= state;
@@ -697,9 +698,10 @@ const initState= function() {
697698
* @typedef {Object} DrawLayerRoot
698699
*
699700
* @summary The state of the Drawing layers store.
700-
* @prop drawLayerAry {DrawLayer[]} the array of all the drawing layers
701-
* @prop allowedActions {string[]} the actions the go to the drawing layers by default
702-
* @prop {{tableId:string, drawLayerTypeId:string}[]} ignoreTables, an array of object that are tableId and
701+
* @prop {DrawLayer[]} drawLayerAry the array of all the drawing layers
702+
* @prop {string[]} allowedActions the actions the go to the drawing layers by default
703+
* @prop {Array.<{tableId:string, drawLayerTypeId:string}>} ignoreTables - an array of object that
704+
* are tableId and a draw layer
703705
*/
704706
return {
705707
allowedActions: [ RETRIEVE_DATA, CREATE_DRAWING_LAYER, DESTROY_DRAWING_LAYER, CHANGE_VISIBILITY,

0 commit comments

Comments
 (0)