DM-7038: use the ink-docstrap as a template, finalized the jsdoc_config.json file, fixed the issue in firefly_api_overview.md so that all links are working

Author: Lijun Zhang

docs/firefly-api-overview.md

@@ -29,7 +29,7 @@ More information about lower level API can be found here:
  - [Region Support](#region-support)
 
 
-###Starting Firefly Tools in JavaScript
+### Starting Firefly Tools in JavaScript
 Getting started with firefly tools involves three basic steps.
 
  1. Load the javascript file `firefly_loader.js`
@@ -62,7 +62,7 @@ This is all best explained with a code example. This examples creates a div with
 </html>
 ```
 
-###Remote Firefly Tools Interface
+### Remote Firefly Tools Interface
 
 The interface to remotely communicate to the firefly viewer:
 
@@ -75,7 +75,7 @@ The interface to remotely communicate to the firefly viewer:
 | *return*  | object | viewer interface |
 
 
-###Rendering UI components
+### Rendering UI components
 
 Firefly React components can be found in `firefly.ui` module.
 
@@ -94,7 +94,7 @@ Firefly React components can be found in `firefly.ui` module.
 | div | string or Object | a div element or a string id of the div element |
 
 
-###Dispatching and watching actions
+### Dispatching and watching actions
 
 Firefly is built around [React](https://facebook.github.io/react/docs/why-react.html)/[Redux](http://redux.js.org) paradigm. The idea of React is that it will always render the state of your component. 
 Redux manages that state of your application. The data in the state is immutable. It cannot change directly. 
@@ -123,7 +123,7 @@ For example, action with type `READOUT_DATA` is dispatched with a function named
 | *return* | function | a function that will remove the listener |
 
 
-###Other Utility Methods 
+### Other Utility Methods 
 
 The rest of Firefly utilities are split into the following modules by function:
 
@@ -133,7 +133,7 @@ The rest of Firefly utilities are split into the following modules by function:
 
 
 
-###FITS Visualization
+### FITS Visualization
 
 A FITS image viewer is created by calling the following method:
 
@@ -187,7 +187,7 @@ firefly.showImage('myDiv', {
 })
 ```
 
-###Deprecated ImageViewer interface
+### Deprecated ImageViewer interface
 
 The following `ImageViewer` interface is deprecated. Please use `firefly.showImage()` instead
 
@@ -207,7 +207,7 @@ Deprecated `ImageViewer` methods:
 
 
 
-###Utility methods for FITS visualization 
+### Utility methods for FITS visualization 
 
 #####**firefly.util.image.getPrimePlot** method
 
@@ -292,7 +292,7 @@ To use minimal readout, do the following:
     );
 ```
 
-###Region Support
+### Region Support
 
 #####**firefly.action.dispatchCreateRegionLayer** method
 
@@ -360,7 +360,7 @@ function onFireflyLoaded() {
 ```
 
 
-###Table Visualization
+### Table Visualization
 
 Creating table request
 
@@ -428,7 +428,7 @@ The Table tools currently supports the following file formats:
 
 
 
-###XY Plot Visualization
+### XY Plot Visualization
 
 - `firefly.showXYPlot(targetDiv, parameters)`
 
@@ -465,7 +465,7 @@ XY Plot supports the same table formats as Table does:
  - FITS Tables
 
 
-###Connecting Coverage image to table
+### Connecting Coverage image to table
 
 `firefly.showCoverage= (div,options)` - add a coverage image to a div
 
@@ -515,7 +515,7 @@ firefly.showCoverage('coverage_div', {gridOn:true})
 
 
 
-###Connecting XY Viewers to table
+### Connecting XY Viewers to table
 
 `firefly.addXYPlot(targetDiv, parameters)` - add an XY Plot to a div
 
@@ -549,6 +549,6 @@ tblReq = firefly.util.table.makeIrsaCatalogRequest('wise catalog', 'WISE', 'wise
 firefly.addXYPlot('xyplot_div', {tbl_id: tblReq.tbl_id, xCol: 'w1mpro+w4mpro', yCol: 'w2mpro'});
 ```
 
-###More Code Examples
+### More Code Examples
 
 [see firefly-api-code-examples.md](firefly-api-code-examples.md)

package.json

@@ -88,6 +88,8 @@
     "eslint-plugin-jsx-a11y": "^0.6.2",
     "jsdoc-jsx": "^0.1.0",
     "minami": "^1.1.1",
-    "ink-docstrap" :"^1.2.1"
+    "ink-docstrap" :"^1.2.1",
+    "file-loader":"^0.09"
+
   }
 }

src/firefly/js/api/ApiBuild.js

@@ -49,6 +49,38 @@ import {buildViewerApi} from './ApiViewer.js';
 import './ApiStyle.css';
 
 
+/**
+ * @namespace firefly
+ */
+/**
+ * @namespace firefly.action
+ * */
+/**
+ * @namespace firefly.ui
+ *
+ */
+/**
+ * @namespace firefly.util
+ *
+ */
+/**
+ * @namespace firefly.util.chat
+ *
+ */
+
+/**
+ * @namespace firefly.util.data
+ *
+ */
+
+/**
+ * @namespace firefly.util.image
+ * */
+
+/**
+ * @namespace firefly.util.table
+ */
+
 /**
  * Start in api mode. Will create the api and call window.onFireflyLoaded(firefly)
  * @ignore
@@ -91,8 +123,6 @@ export function initApi() {
    }
 */
 
-
-
 /**
  * Return the api object.
  * @return {{action:{},ui:{},util:{}}}

src/firefly/js/api/ApiHighlevelBuild.js

@@ -16,7 +16,6 @@
 /**
  * @public
  * @desc build highLevelApi using the lowLevelApi as an input
- * @namespace firefly
  */
 
 /**

src/firefly/js/api/ApiUtil.js

@@ -21,7 +21,6 @@ import {take,race,call} from 'redux-saga/effects';
 // NOTE
 /**
  * @public
- * @namespace firefly/util
  */
 export {getBoolean} from '../util/WebUtil.js';
 export {toBoolean} from '../util/WebUtil.js';
@@ -32,7 +31,7 @@ export {toBoolean} from '../util/WebUtil.js';
  * @func isDebug
  * @static
  * @public
- * @memberof firefly/util
+ * @memberof firefly.util
  *
  */
 export const isDebug = () => get(window, 'firefly.debug', false);
@@ -42,7 +41,7 @@ export const isDebug = () => get(window, 'firefly.debug', false);
  * @param {String|Error} msg any number of messages
  * @public
  * @func debug
- * @memberof firefly/util
+ * @memberof firefly.util
  *
  */
 export function debug(...msg) {
@@ -57,7 +56,7 @@ export function debug(...msg) {
  * @param {Object} [props] props for the react component
  * @public
  * @function renderDOM
- * @memberof firefly/util
+ * @memberof firefly.util
  */
 
 export function renderDOM(div, Component, props) {
@@ -83,7 +82,7 @@ export function renderDOM(div, Component, props) {
  * @param {string|Object} div a div element or a string id of the div element
  * @public
  * @function unrenderDOM
- * @memberof firefly/util
+ * @memberof firefly.util
  */
 
 export function unrenderDOM(div) {
@@ -100,7 +99,7 @@ export function unrenderDOM(div) {
  * @return {function} a function that will remove the listener
  * @public
  * @func addActionListener
- * @memberof firefly/util
+ * @memberof firefly.util
  */
 export function addActionListener(actionType,callBack) {
     var pResolve;
@@ -128,7 +127,7 @@ export function addActionListener(actionType,callBack) {
  * @param getState a function get the application state
  * @private
  * @func actionReport
- *  @memberof firefly/util
+ *  @memberof firefly.util
  *
  */
 function *actionReport({actionType,callBack, cancelPromise},dispatch,getState) {

src/firefly/js/api/ApiUtilImage.jsx

@@ -28,9 +28,12 @@ const API_READOUT= 'apiReadout';
 // NOTE 
 // NOTE 
 
+/**
+ * @namespace firefly.util.image.CCUtil
+ **/
+
 /**
  * @public
- * @namespace firefly/util/image
  *
  */
 export {RangeValues} from '../visualize/RangeValues.js';
@@ -56,7 +59,7 @@ export {watchImageMetaData} from '../visualize/saga/ImageMetaDataWatcher.js';
  * @returns {WebPlot}
  * @public
  * @function getPrimePlot
- * @memberof firefly/util/image
+ * @memberof firefly.util.image
  *
  */
 export function getPrimePlot(plotId) {
@@ -69,7 +72,7 @@ export function getPrimePlot(plotId) {
  * @param {object} props - a list of the properties
  * @public
  * @function initAutoReadout
- * @memberof firefly/util/image
+ * @memberof firefly.util.image
  */
 export function initAutoReadout(ReadoutComponent= DefaultApiReadout,
          //   props={MouseReadoutComponent:PopupMouseReadoutMinimal, showThumb:false,showMag:false}){
@@ -88,7 +91,7 @@ export function initAutoReadout(ReadoutComponent= DefaultApiReadout,
  * @param algorithm the stretch algorithm to use, may be 'Linear', 'Log', 'LogLog', 'Equal', 'Squared', 'Sqrt'
  * @public
  * @function serializeSimpleRangeValues
- *  @memberof firefly/util/image
+ *  @memberof firefly.util.image
  */
 export function serializeSimpleRangeValues(stretchType,lowerValue,upperValue,algorithm) {
     const rv= RangeValues.makeSimple(stretchType,lowerValue,upperValue,algorithm);

src/firefly/js/api/ApiViewer.js

@@ -6,7 +6,6 @@
 /**
  * @public
  * @summary Build the interface to remotely communicate to the firefly viewer
- * @namespace firefly
  */
 import {take} from 'redux-saga/effects';
 import {isArray, get} from 'lodash';

src/firefly/js/charts/XYPlotCntlr.js

@@ -26,7 +26,6 @@ const SET_ZOOM = `${XYPLOT_DATA_KEY}/SET_ZOOM`;
 const RESET_ZOOM = `${XYPLOT_DATA_KEY}/RESET_ZOOM`;
 /**
  * @public
- * @namespace firefly/action
  */
 
 /*
@@ -83,7 +82,7 @@ const RESET_ZOOM = `${XYPLOT_DATA_KEY}/RESET_ZOOM`;
  * @param {function} dispatcher only for special dispatching uses such as remote
  * @public
  * @function dispatchLoadPlotData
- * @memberof firefly/action
+ * @memberof firefly.action
  *
  */
 export function dispatchLoadPlotData(chartId, xyPlotParams, tblId, dispatcher= flux.process) {
@@ -96,7 +95,7 @@ export function dispatchLoadPlotData(chartId, xyPlotParams, tblId, dispatcher= f
  * @param {Object} selection - {xMin, xMax, yMin, yMax}
  * @public
  * @func dispatchSetSelection
- * @memberof firefly/action
+ * @memberof firefly.action
  */
 export function dispatchSetSelection(chartId, selection) {
     flux.process({type: SET_SELECTION, payload: {chartId, selection}});
@@ -109,7 +108,7 @@ export function dispatchSetSelection(chartId, selection) {
  * @param {Object} selection - {xMin, xMax, yMin, yMax}
  * @public
  * @func dispatchZoom
- * @memberof firefly/action
+ * @memberof firefly.action
  */
 export function dispatchZoom(chartId, tblId, selection) {
     const {xyPlotData, xyPlotParams, decimatedUnzoomed} = get(getChartSpace(SCATTER), chartId, {});
@@ -155,7 +154,7 @@ function dispatchResetZoom(chartId) {
  * @returns function which loads plot data (x, y, rowIdx, etc.)
  * @public
  * @func loadPlotData
- * @memberof firefly/action
+ * @memberof firefly.action
  */
 export function loadPlotData (rawAction) {
     return (dispatch) => {
@@ -206,7 +205,7 @@ function serverParamsChanged(oldParams, newParams) {
  * decimatedUnzoomed - tells if unzoomed data are decimated
  * @param data {Object} the data to merge with the xyplot branch
  * @returns {{type: string, payload: object}}
- * @memberof firefly/action
+ * @memberof firefly.action
  * @public
  * @func updatePlotData
  */