Updated docstring for getFFTFreq()

psambit9791 · Aug 1, 2022 · 1ca8754 · 1ca8754
1 parent 48f1ee0
commit 1ca8754
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>com.github.psambit9791</groupId>
     <artifactId>jdsp</artifactId>
-    <version>2.0.0-SNAPSHOT</version>
+    <version>2.0.0</version>
 
     <distributionManagement>
         <snapshotRepository>

diff --git a/src/main/java/com/github/psambit9791/jdsp/transform/DiscreteFourier.java b/src/main/java/com/github/psambit9791/jdsp/transform/DiscreteFourier.java
@@ -49,7 +49,7 @@ public int getSignalLength() {
 
 
     /**
-     * Returns the frequencies of the FFT bins are computation
+     * Returns the frequencies of the FFT bins based on the signal length and sampling frequency
      * @param Fs Sampling frequency of the signal
      * @param onlyPositive Set to True if non-mirrored output is required
      * @return double[] Array of frequency bins

diff --git a/src/main/java/com/github/psambit9791/jdsp/transform/FastFourier.java b/src/main/java/com/github/psambit9791/jdsp/transform/FastFourier.java
@@ -58,7 +58,7 @@ public int getSignalLength() {
     }
 
     /**
-     * Returns the frequencies of the FFT bins are computation
+     * Returns the frequencies of the FFT bins based on the signal length and sampling frequency
      * @param Fs Sampling frequency of the signal
      * @param onlyPositive Set to True if non-mirrored output is required
      * @return double[] Array of frequency bins