Skip to content

Commit 9c68339

Browse files
committed
Fixed some Doxygen comments in the audio headers.
1 parent cf7d08c commit 9c68339

File tree

2 files changed

+2
-6
lines changed

2 files changed

+2
-6
lines changed

Diff for: src/libprojectM/Audio/MilkdropFFT.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ class MilkdropFFT
5555
MilkdropFFT(size_t samplesIn, size_t samplesOut, bool equalize = true, float envelopePower = 1.0f);
5656

5757
/**
58-
* @breif Converts time-domain samples into frequency-domain samples.
58+
* @brief Converts time-domain samples into frequency-domain samples.
5959
* The array lengths are the two parameters to Init().
6060
*
6161
* The last sample of the output data will represent the frequency

Diff for: src/libprojectM/Audio/WaveformAligner.hpp

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
/**
22
* @file WaveformAligner.hpp
33
* @brief Mip-based waveform alignment algorithm
4-
*
5-
* Calculates the absolute error between the previous and current waveforms over several octaves
6-
* and sample offsets, then shifts the new waveform forward to best align with the previous frame.
7-
* This will keep similar features in-place instead of randomly jumping around on each frame and creates
8-
* for a smoother-looking waveform visualization.
94
*/
105

116
#pragma once
@@ -19,6 +14,7 @@ namespace libprojectM {
1914
namespace Audio {
2015

2116
/**
17+
* @class WaveformAligner
2218
* @brief Mip-based waveform alignment algorithm
2319
*
2420
* Calculates the absolute error between the previous and current waveforms over several octaves

0 commit comments

Comments
 (0)