Skip to content

Commit 2a82e0f

Browse files
author
Lijun Zhang
committed
DM-7038:fixed some tags
1 parent 1c95589 commit 2a82e0f

File tree

3 files changed

+24
-35
lines changed

3 files changed

+24
-35
lines changed

src/firefly/js/api/ApiBuild.js

Lines changed: 13 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -49,37 +49,22 @@ import {buildViewerApi} from './ApiViewer.js';
4949
import './ApiStyle.css';
5050

5151

52-
/**
53-
* @namespace firefly
54-
*/
55-
/**
56-
* @namespace firefly.action
57-
* */
58-
/**
59-
* @namespace firefly.ui
60-
*
61-
*/
62-
/**
63-
* @namespace firefly.util
64-
*
65-
*/
66-
/**
67-
* @namespace firefly.util.chat
68-
*
69-
*/
52+
/**@namespace firefly*/
7053

71-
/**
72-
* @namespace firefly.util.data
73-
*
74-
*/
54+
/**@namespace firefly.action*/
7555

76-
/**
77-
* @namespace firefly.util.image
78-
* */
56+
/**@namespace firefly.ui*/
57+
58+
/**@namespace firefly.util*/
59+
60+
/** @namespace firefly.util.chat*/
61+
62+
/** @namespace firefly.util.data*/
63+
64+
/**@namespace firefly.util.image*/
65+
66+
/** @namespace firefly.util.table*/
7967

80-
/**
81-
* @namespace firefly.util.table
82-
*/
8368

8469
/**
8570
* Start in api mode. Will create the api and call window.onFireflyLoaded(firefly)

src/firefly/js/visualize/CsysConverter.js

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,6 @@ export class CysConverter {
576576
* @param pt
577577
* @return {*}
578578
* @memberof firefly.util.image.CCUtil
579-
* @func getWorldPtRepresentation
580579
* @public
581580
*/
582581
function getWorldPtRepresentation(pt) {
@@ -597,8 +596,7 @@ export const CCUtil = {
597596
/**
598597
* Convert to ImageWorkSpace Point
599598
* @param {object} plot - the image
600-
* @func getImageWorkSpaceCoords
601-
* @memberof firefly.util.image.CCUtil
599+
* @memberof firefly.util.image.CCUtil
602600
* @public
603601
*
604602
*/
@@ -610,7 +608,6 @@ export const CCUtil = {
610608
* Convert to Image Point
611609
* @param {object} plot - the image
612610
* @param {object} pt - the point to convert
613-
* @function getImageCoords
614611
* @memberof firefly.util.image.CCUtil
615612
* @public
616613
*/
@@ -623,7 +620,6 @@ export const CCUtil = {
623620
/**
624621
* @param {object} plot - the image
625622
* @param {object} pt - the point to convert
626-
* @function getViewPortCoords
627623
* @public
628624
* @memberof firefly.util.image.CCUtil
629625
*/
@@ -646,7 +642,6 @@ export const CCUtil = {
646642
* Convert to World Point
647643
* @param {object} plot - the image
648644
* @param {object} pt - the point to convert
649-
* @function getWorldCoords
650645
* @memberof firefly.util.image.CCUtil
651646
* @public
652647
*/

src/firefly/js/visualize/DrawLayerCntlr.js

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ export function dispatchAttachLayerToPlot(id,plotId, attachPlotGroup=false) {
266266
* @param destroyWhenAllDetached if all plots are detached then destroy this plot
267267
* @public
268268
* @memberof firefly.action
269-
* @func dispatchDetachLayerFromPlot
269+
* @func dispatchDetachLayerFromPlot
270270
*/
271271
export function dispatchDetachLayerFromPlot(id,plotId, detachPlotGroup=false,
272272
useLayerGroup=true, destroyWhenAllDetached=false) {
@@ -308,6 +308,8 @@ export function dispatchCreateRegionLayer(drawLayerId, layerTitle, fileOnServer=
308308
* @param drawLayerId
309309
* @param plotId
310310
* @param dispatcher
311+
* @func dispatchDeleteRegionLayer
312+
* @memberof firefly.action
311313
*/
312314
export function dispatchDeleteRegionLayer(drawLayerId, plotId, dispatcher = flux.process) {
313315
dispatcher({type: REGION_DELETE_LAYER, payload: {drawLayerId, plotId}});
@@ -323,6 +325,9 @@ export function dispatchDeleteRegionLayer(drawLayerId, plotId, dispatcher = flux
323325
* @param plotId The region layer is created on all plots of the active plot group in plotId is empty
324326
* @param layerTitle
325327
* @param dispatcher
328+
* @func dispatchAddRegionEntry
329+
* @memberof firefly.action
330+
326331
*/
327332
export function dispatchAddRegionEntry(drawLayerId, regionChanges, plotId=[], layerTitle='', dispatcher = flux.process) {
328333
dispatcher({type: REGION_ADD_ENTRY, payload: {drawLayerId, regionChanges, plotId, layerTitle}});
@@ -333,6 +338,9 @@ export function dispatchAddRegionEntry(drawLayerId, regionChanges, plotId=[], la
333338
* @param drawLayerId
334339
* @param regionChanges
335340
* @param dispatcher
341+
* @func dispatchRemoveRegionEntry
342+
* @memberof firefly.action
343+
336344
*/
337345
export function dispatchRemoveRegionEntry(drawLayerId, regionChanges, dispatcher = flux.process) {
338346
dispatcher({type: REGION_REMOVE_ENTRY, payload: {drawLayerId, regionChanges}});
@@ -590,6 +598,7 @@ function deletePlotView(state,action, dlReducer) {
590598
* @param state
591599
* @param action
592600
* @param dlReducer
601+
* @memberof firefly.action
593602
* @returns {Object}
594603
*/
595604
function destroyDrawLayerNoRegion(state, action, dlReducer) {

0 commit comments

Comments
 (0)