jsdoc for .tsx

Author: laemtl

.eslintignore

@@ -22,3 +22,6 @@ htdocs/js/FileSaver.min.js
 htdocs/vendor/
 htdocs/fontawesome/
 htdocs/bootstrap/
+
+# ignore until eslint errors are fixed
+modules/electrophysiology_browser/jsx/react-series-data-viewer/src/series/components/**

.eslintrc.json

@@ -95,6 +95,18 @@
         "plugin:@typescript-eslint/recommended"
       ],
       "rules": {
+        "jsdoc/require-jsdoc": [
+          "error",
+          {"require": {
+            "ArrowFunctionExpression": true,
+            "FunctionExpression": true,
+            "ClassDeclaration": true,
+            "MethodDefinition": true
+          }}
+        ],
+        "jsdoc/require-param-description": "error",
+        "jsdoc/require-returns": "error",
+        "jsdoc/require-returns-description": "error",
         "no-undef": "off",
         "@typescript-eslint/ban-ts-comment": "off",
         "@typescript-eslint/no-explicit-any": "off"

modules/electrophysiology_browser/jsx/react-series-data-viewer/src/ajax/index.tsx

@@ -1,3 +1,10 @@
+/**
+ * fetchBlob
+ *
+ * @param {string} url - The url to fetch
+ * @param {object} params - The request params
+ * @returns {Promise} - The blob data
+ */
 export const fetchBlob = (url: string, params?: RequestInit) : Promise<Blob> =>
   fetch(url, params).then((response) => {
     if (!response.ok) {
@@ -6,6 +13,13 @@ export const fetchBlob = (url: string, params?: RequestInit) : Promise<Blob> =>
     return response.blob().then((data) => data);
   });
 
+/**
+ * fetchJSON
+ *
+ * @param {string} url - The url to fetch
+ * @param {object} params - The request params
+ * @returns {Promise} - The json data
+ */
 export const fetchJSON = (url: string, params?: RequestInit) =>
   fetch(url, params).then((response) => {
     if (!response.ok) {
@@ -14,6 +28,13 @@ export const fetchJSON = (url: string, params?: RequestInit) =>
     return response.json().then((data) => data);
   });
 
+/**
+ * fetchText
+ *
+ * @param {string} url - The url to fetch
+ * @param {object} params - The request params
+ * @returns {Promise} - The text data
+ */
 export const fetchText = (url: string, params?: RequestInit) =>
   fetch(url, params).then((response) => {
     if (!response.ok) {

modules/electrophysiology_browser/jsx/react-series-data-viewer/src/chunks/index.tsx

@@ -2,6 +2,12 @@
 import {FloatChunk} from '../protocol-buffers/chunk_pb';
 import {fetchBlob} from '../ajax';
 
+/**
+ * fetchChunk
+ *
+ * @param {string} url - The url to fetch
+ * @returns {Promise} - The chunk data
+ */
 export const fetchChunk = (url: string): Promise<typeof FloatChunk> => {
   return fetchBlob(url).then((blob) => {
     const reader = new FileReader();

modules/electrophysiology_browser/jsx/react-series-data-viewer/src/color/index.tsx

@@ -8,6 +8,14 @@ import {scaleOrdinal} from 'd3-scale';
 
 export const colorOrder = scaleOrdinal();
 
+/**
+ * hex2rgba
+ *
+ * @param {object} root - An object
+ * @param {string} root.color - An hexadecimal color
+ * @param {number} root.alpha - Opacity
+ * @returns {string} - An rgba expression
+ */
 export const hex2rgba = ({color = '#000000', alpha = 1} : {
   color: string,
   alpha: number,

modules/electrophysiology_browser/jsx/react-series-data-viewer/src/eeglab/EEGLabSeriesProvider.tsx

@@ -79,6 +79,13 @@ class EEGLabSeriesProvider extends Component<CProps> {
 
     this.store.dispatch(setPhysioFileID(physioFileID));
 
+    /**
+     *
+     * @param {Function} fetcher The fn to collect the type of data
+     * @param {string} url - The url
+     * @param {string} route - The route
+     * @returns {Promise} - The data
+     */
     const racers = (fetcher, url, route = '') => {
       if (url) {
         return [fetcher(`${url}${route}`)
@@ -196,7 +203,7 @@ class EEGLabSeriesProvider extends Component<CProps> {
   /**
    * Renders the React component.
    *
-   * @return {JSX} - React markup for the component
+   * @returns {JSX} - React markup for the component
    */
   render() {
     const [signalViewer, ...rest] = React.Children.toArray(this.props.children);

modules/electrophysiology_browser/jsx/react-series-data-viewer/src/series/components/AnnotationForm.tsx

@@ -31,6 +31,20 @@ type CProps = {
   interval: [number, number],
 };
 
+/**
+ *
+ * @param root0
+ * @param root0.timeSelection
+ * @param root0.epochs
+ * @param root0.setTimeSelection
+ * @param root0.setRightPanel
+ * @param root0.setEpochs
+ * @param root0.currentAnnotation
+ * @param root0.setCurrentAnnotation
+ * @param root0.physioFileID
+ * @param root0.annotationMetadata
+ * @param root0.interval
+ */
 const AnnotationForm = ({
   timeSelection,
   epochs,
@@ -65,6 +79,10 @@ const AnnotationForm = ({
     setEvent([startEvent, endEvent]);
   }, [timeSelection]);
 
+  /**
+   *
+   * @param event
+   */
   const validate = (event) => (
     (event[0] || event[0] === 0)
       && (event[1] || event[1] === 0)
@@ -73,6 +91,11 @@ const AnnotationForm = ({
       && event[1] >= interval[0] && event[1] <= interval[1]
   );
 
+  /**
+   *
+   * @param id
+   * @param val
+   */
   const handleStartTimeChange = (id, val) => {
     const value = parseInt(val);
     setEvent([value, event[1]]);
@@ -91,6 +114,11 @@ const AnnotationForm = ({
     }
   };
 
+  /**
+   *
+   * @param name
+   * @param val
+   */
   const handleEndTimeChange = (name, val) => {
     const value = parseInt(val);
     setEvent([event[0], value]);
@@ -109,16 +137,32 @@ const AnnotationForm = ({
     }
   };
 
+  /**
+   *
+   * @param name
+   * @param value
+   */
   const handleLabelChange = (name, value) => {
     setLabel(value);
   };
+  /**
+   *
+   * @param name
+   * @param value
+   */
   const handleCommentChange = (name, value) => {
     setComment(value);
   };
+  /**
+   *
+   */
   const handleSubmit = () => {
     setIsSubmitted(true);
   };
 
+  /**
+   *
+   */
   const handleReset = () => {
     // Clear all fields
     setEvent(['', '']);
@@ -127,6 +171,9 @@ const AnnotationForm = ({
     setComment('');
   };
 
+  /**
+   *
+   */
   const handleDelete = () => {
     setIsDeleted(true);
   };

modules/electrophysiology_browser/jsx/react-series-data-viewer/src/series/components/Axis.tsx

@@ -11,6 +11,17 @@ type CProps = {
   hideLine: boolean,
 };
 
+/**
+ *
+ * @param root0
+ * @param root0.orientation
+ * @param root0.domain
+ * @param root0.range
+ * @param root0.ticks
+ * @param root0.padding
+ * @param root0.format
+ * @param root0.hideLine
+ */
 const Axis = ({
   orientation,
   domain,
@@ -45,6 +56,10 @@ Axis.defaultProps = {
   ticks: 10,
   padding: 0,
   hideLine: false,
+  /**
+   *
+   * @param tick
+   */
   format: (tick) => `${tick}`,
 };
 

modules/electrophysiology_browser/jsx/react-series-data-viewer/src/series/components/EEGMontage.tsx

@@ -21,6 +21,12 @@ type CProps = {
   physioFileID: number,
 };
 
+/**
+ *
+ * @param root0
+ * @param root0.electrodes
+ * @param root0.physioFileID
+ */
 const EEGMontage = (
   {
     electrodes,
@@ -49,12 +55,20 @@ const EEGMontage = (
     .rotateZ( startAngle)
     .rotateX(-startAngle);
 
+  /**
+   *
+   * @param v
+   */
   const dragStart = (v: any) => {
     setDrag(true);
     setMx(v[0]);
     setMy(v[1]);
   };
 
+  /**
+   *
+   * @param v
+   */
   const dragged = (v: any) => {
     if (!drag) return;
     const beta = (v[0] - mx + mouseX) * -2 * Math.PI;
@@ -67,6 +81,10 @@ const EEGMontage = (
     setAngleZ(angleZ);
   };
 
+  /**
+   *
+   * @param v
+   */
   const dragEnd = (v: any) => {
     setDrag(false);
     setMouseX(v[0] - mx + mouseX);
@@ -185,6 +203,9 @@ const EEGMontage = (
     scatter2D.push({x: x * scale2D, y: y * scale2D});
   });
 
+  /**
+   *
+   */
   const Montage3D = () => (
     <Group>
       {point3D.rotateZ(angleZ).rotateX(angleX)(scatter3D).map((point, i) => {
@@ -205,6 +226,9 @@ const EEGMontage = (
     </Group>
   );
 
+  /**
+   *
+   */
   const Montage2D = () => (
     <Group>
       <line

modules/electrophysiology_browser/jsx/react-series-data-viewer/src/series/components/Epoch.tsx

@@ -14,6 +14,16 @@ type CProps = {
   opacity: number,
 };
 
+/**
+ *
+ * @param root0
+ * @param root0.parentHeight
+ * @param root0.onset
+ * @param root0.duration
+ * @param root0.scales
+ * @param root0.color
+ * @param root0.opacity
+ */
 const Epoch = (
   {
     parentHeight,