more comments in HealthChart.tsx

Author: Jeffrey Na

app/charts/HealthChart.tsx

@@ -28,7 +28,7 @@ type PlotlyData = {
 /**
  * @params {HealthChartProps} props - the props object containing necessary data.
  * @desc Memoized component to generate a health chart with formatted data.
- * @returns JSX element with the health chart. 
+ * @returns {JSX.Element} The JSX element with the health chart. 
  */
 const HealthChart: React.FC<HealthChartProps> = React.memo(props => {
   const { dataType, serviceName, chartData, categoryName, sizing, colourGenerator } = props;
@@ -94,6 +94,10 @@ const HealthChart: React.FC<HealthChartProps> = React.memo(props => {
     }
   }, 20);
 
+  /**
+   * @desc Takes the chart data and configures Plotly object to render associated health chart.
+   * @returns {JSX.Element} Configured Plotly object representing health chart.
+   */
   const createChart = () => {
     const dataArray = generatePlotlyDataObjects(chartData);
     const sizeSwitch = sizing === 'all' ? all : solo;