Add comments to FFTCmpt.js

Menouard AZIB
1 parent 11c71fa5
Showing 2 changed files with 14 additions and 6 deletions Show diff stats
js/app/views/PlotComponents/intervalSelection/PlotFunctionIntervalSelection.js
js/app/views/PlotComponents/plotFunction/FFTCmpt.js
@@ -2,7 +2,7 @@ Ext.define(&#39;amdaPlotComp.intervalSelection.PlotFunctionIntervalSelection&#39;, {
     extend: 'amdaPlotComp.intervalSelection.IntervalSelection', // This class extends from amdaPlotComp.intervalSelection.IntervalSelection
     requires: ['amdaPlotComp.plotFunction.FunctionType'], // This class requires the FunctionType class from amdaPlotComp.plotFunction
-    title: "Plot Function", // The title of this interval selection
+    title: "Plot Function", // The title of the window
     plotFunctionType: null, // An instance of the FunctionType class, initially set to null
     /**
 Ext.define('amdaPlotComp.plotFunction.FFTCmpt', {
-    extend: 'amdaPlotComp.plotFunction.BaseComponent',
-    title: "FFT Arguments",
-    id: 'fftComboBox',
-  
+    extend: 'amdaPlotComp.plotFunction.BaseComponent', // This class extends from amdaPlotComp.plotFunction.BaseComponent
+    title: "FFT Arguments", // The title of this component
+    id: 'fftComboBox', // The id of this component
+
+    /**
+     * Initializes the component.
+     * It creates a combo box with two options, 'Frequency' and 'Period', and adds it to the component.
+     */
     initComponent: function () {
         const me = this;
@@ -34,8 +38,12 @@ Ext.define(&#39;amdaPlotComp.plotFunction.FFTCmpt&#39;, {
         me.callParent(arguments);
     },
+    /**
+     * Retrieves the selected value from the combo box.
+     * Returns an object with a property 'abscisse' set to the selected value.
+     */
     getValues: function () {
-        const fftComboBox = this.down('#'+this.id); // Retrieve ComboBox by itemId
+        const fftComboBox = this.down('#' + this.id); // Retrieve ComboBox by itemId
         const selectedValue = fftComboBox.getValue(); // Get selected value
         return {