Add Maven Wrapper and enable Javadocs generation

- Set up Maven Wrapper (mvnw) for consistent builds across environments
- Added the ability to generate Javadocs using the full-build profile
- Updated build instructions to reflect Maven Wrapper usage and Javadocs location
- Improved build process and ensured Javadocs are generated in target/apidocs/
This commit is contained in:
Eric Ratliff
2024-09-14 11:37:30 -05:00
parent dc4e379b95
commit cca4690a4c
7 changed files with 604 additions and 16 deletions

View File

@@ -27,12 +27,11 @@ import org.apache.commons.math3.transform.TransformType;
/**
* The {@code App} class is a JavaFX application that demonstrates signal processing concepts
* such as filtering and Fast Fourier Transform (FFT) analysis.
* <p>
*
* This program allows users to control the speed of a motor (simulated via a slider),
* apply different types of filters (raised cosine and low-pass), and visualize the time-domain
* signal and its frequency-domain representation (FFT).
* </p>
* <p>
*
* Key features include:
* <ul>
* <li>A vertical slider to adjust the speed of the signal in real-time.</li>
@@ -41,11 +40,9 @@ import org.apache.commons.math3.transform.TransformType;
* <li>An oscillation feature to automate speed changes in a square wave pattern.</li>
* <li>Real-time plots of both time-domain and frequency-domain (FFT) data.</li>
* </ul>
* </p>
* <p>
*
* This class is intended as an educational tool for students learning about signal processing
* in the context of controlling a robot motor.
* </p>
*
* <h2>Usage:</h2>
* <ol>
@@ -63,10 +60,9 @@ import org.apache.commons.math3.transform.TransformType;
* <li>Raised cosine and low-pass filters: Techniques to shape and smooth the signal.</li>
* </ul>
*
* <p>
*
* This application is designed to be simple and interactive, making it a useful tool
* for beginners in both programming and signal processing.
* </p>
*
* @author Eric Ratliff
* @version 1.0.0

View File

@@ -47,7 +47,6 @@ public class FFTUtils {
* @param fftSize the desired size of the FFT (the number of points in the frequency domain)
* @return an array of {@code Complex} numbers representing the frequency components of the input signal
*
* <h2>Details:</h2>
* <ul>
* <li>If the number of samples is less than {@code fftSize}, the input array is padded with zeros.</li>
* <li>If the number of samples exceeds {@code fftSize}, the input array is truncated.</li>