Skip to content
This repository was archived by the owner on Apr 11, 2024. It is now read-only.

Commit c6a8b4d

Browse files
committed
Updating JSDOC.
1 parent 244e98c commit c6a8b4d

File tree

11 files changed

+21
-20
lines changed

11 files changed

+21
-20
lines changed

client/components/BasicTree.jsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,3 +148,4 @@ export default function BasicTree(props) {
148148
</TreeView>
149149
);
150150
}
151+

client/components/ChronosTimeSlider.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,4 +261,4 @@ function ChronosTimeSlider(props) {
261261
);
262262
}
263263

264-
export default ChronosTimeSlider;
264+
export default ChronosTimeSlider;

client/components/CustomToolTip.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,4 +127,4 @@ function CustomToolTip(props) {
127127
return null;
128128
}
129129

130-
export default CustomToolTip;
130+
export default CustomToolTip;

client/components/Dashboard.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,4 +117,4 @@ function Dashboard(props) {
117117
);
118118
}
119119

120-
export default Dashboard;
120+
export default Dashboard;

client/components/DataPanelContainer.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,4 +142,4 @@ function DataPanelContainer(props) {
142142
);
143143
}
144144

145-
export default DataPanelContainer;
145+
export default DataPanelContainer;

client/components/DevicePanel.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,4 +159,4 @@ function DevicePanel(props) {
159159
);
160160
}
161161

162-
export default DevicePanel;
162+
export default DevicePanel;

client/components/DeviceStats.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ function DeviceStats(props) {
5757
);
5858
}
5959

60-
export default DeviceStats;
60+
export default DeviceStats;

client/components/DeviceTree.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,4 +220,4 @@ function DeviceTree(props) {
220220
);
221221
}
222222

223-
export default DeviceTree;
223+
export default DeviceTree;

client/components/HeatmapOptions.jsx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -146,10 +146,10 @@ const ResolutionCustomForm = withStyles({
146146
* @param {OnHeatMapOptionChange} props.onHeatmapOptionChange A callback function invoked when any combination of
147147
* &nbsp;resolutionValue, selectedPropertyId, and showHeatMap are changed.
148148
*
149-
* @memberof Autodesk.DataVisualization.UI.SurfaceShader
150-
* @alias Autodesk.DataVisualization.UI.SurfaceShader.ShaderOptionsMenu
149+
* @memberof Autodesk.DataVisualization.UI.HeatmapOptions
150+
* @alias Autodesk.DataVisualization.UI.HeatmapOptions.HeatmapSelectionMenu
151151
*/
152-
function ShaderOptionsMenu(props) {
152+
function HeatmapSelectionMenu(props) {
153153
const resolutionValue = props.resolutionValue;
154154
const selectedPropertyId = props.selectedPropertyId;
155155
const showHeatMap = props.showHeatMap;
@@ -287,10 +287,10 @@ function ShaderOptionsMenu(props) {
287287
* @param {GetPropertyRanges} props.getPropertyRanges The function to get the selected property's range and dataUnit
288288
* @param {number} props.totalMarkers The total number of slider marks to display on the slider.
289289
*
290-
* @memberof Autodesk.DataVisualization.UI.SurfaceShader
291-
* @alias Autodesk.DataVisualization.UI.SurfaceShader.ShaderSlider
290+
* @memberof Autodesk.DataVisualization.UI.HeatmapOptions
291+
* @alias Autodesk.DataVisualization.UI.HeatmapOptions.GradientBar
292292
*/
293-
function ShaderSlider(props) {
293+
function GradientBar(props) {
294294
const [sliderMarks, setSliderMarks] = useState([
295295
{ value: 20, label: "1" },
296296
{ value: 40, label: "2" },
@@ -353,7 +353,7 @@ function ShaderSlider(props) {
353353
}
354354

355355
/**
356-
* The surface shader component with a linear gradient and options menu.
356+
* The HeatmapOptions component with a linear gradient and an options menu.
357357
* @component
358358
*
359359
* @param props
@@ -369,17 +369,17 @@ function ShaderSlider(props) {
369369
* @param {Map.<string, DeviceProperty>} props.deviceModelProperties Map of all the properties across all devicesModels in a {@link DataStore} object.
370370
*
371371
* @memberof Autodesk.DataVisualization.UI
372-
* @alias Autodesk.DataVisualization.UI.SurfaceShader
372+
* @alias Autodesk.DataVisualization.UI.HeatmapOptions
373373
*/
374374
function HeatmapOptions(props) {
375375
const classes = useStyles();
376376

377377
return (
378378
<div id="surfaceShader_Container" className={classes.root}>
379-
<ShaderSlider {...props} />
380-
<ShaderOptionsMenu {...props} />
379+
<GradientBar {...props} />
380+
<HeatmapSelectionMenu {...props} />
381381
</div>
382382
);
383383
}
384384

385-
export default HeatmapOptions;
385+
export default HeatmapOptions;

client/components/HyperionToolContainer.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -553,4 +553,4 @@ function HyperionToolContainer(props) {
553553
);
554554
}
555555

556-
export default HyperionToolContainer;
556+
export default HyperionToolContainer;

0 commit comments

Comments
 (0)