From 4b6be143cf75f21436aeb69c23abfcd3b183fe46 Mon Sep 17 00:00:00 2001 From: ed Date: Mon, 18 May 2020 14:43:50 +0100 Subject: [PATCH] Fixed some doxygen warnings --- .../utilities/juce_ParameterAttachments.h | 4 ++-- modules/juce_core/files/juce_DirectoryIterator.h | 6 ------ modules/juce_dsp/widgets/juce_LadderFilter.h | 12 +++++++++--- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/modules/juce_audio_processors/utilities/juce_ParameterAttachments.h b/modules/juce_audio_processors/utilities/juce_ParameterAttachments.h index 0f9e82868f..1960aa28b2 100644 --- a/modules/juce_audio_processors/utilities/juce_ParameterAttachments.h +++ b/modules/juce_audio_processors/utilities/juce_ParameterAttachments.h @@ -45,7 +45,7 @@ public: @param parameter The parameter to which this attachment will listen @param parameterChangedCallback The function that will be called on the message thread in response to parameter changes - @param uundoManager The UndoManager that will be used to begin transactions when the UI + @param undoManager The UndoManager that will be used to begin transactions when the UI requests a parameter change. */ ParameterAttachment (RangedAudioParameter& parameter, @@ -209,7 +209,7 @@ public: /** Creates a connection between a plug-in parameter and a Button. @param parameter The parameter to use - @param combo The Button to use + @param button The Button to use @param undoManager An optional UndoManager */ ButtonParameterAttachment (RangedAudioParameter& parameter, Button& button, diff --git a/modules/juce_core/files/juce_DirectoryIterator.h b/modules/juce_core/files/juce_DirectoryIterator.h index 0e7e4b64c7..0988306eaf 100644 --- a/modules/juce_core/files/juce_DirectoryIterator.h +++ b/modules/juce_core/files/juce_DirectoryIterator.h @@ -67,12 +67,6 @@ public: } @endcode - @param directory the directory to search in - @param isRecursive whether all the subdirectories should also be searched - @param wildCard the file pattern to match. This may contain multiple patterns - separated by a semi-colon or comma, e.g. "*.jpg;*.png" - @param whatToLookFor a value from the File::TypesOfFileToFind enum, specifying - whether to look for files, directories, or both. @see RangedDirectoryIterator */ JUCE_DEPRECATED (DirectoryIterator (const File& directory, diff --git a/modules/juce_dsp/widgets/juce_LadderFilter.h b/modules/juce_dsp/widgets/juce_LadderFilter.h index eed20521fe..efd6840a0d 100644 --- a/modules/juce_dsp/widgets/juce_LadderFilter.h +++ b/modules/juce_dsp/widgets/juce_LadderFilter.h @@ -63,15 +63,21 @@ public: void reset() noexcept; /** Sets the cutoff frequency of the filter. - @param newValue cutoff frequency in Hz */ + + @param newCutoff cutoff frequency in Hz + */ void setCutoffFrequencyHz (SampleType newCutoff) noexcept; /** Sets the resonance of the filter. - @param newValue a value between 0 and 1; higher values increase the resonance and can result in self oscillation! */ + + @param newResonance a value between 0 and 1; higher values increase the resonance and can result in self oscillation! + */ void setResonance (SampleType newResonance) noexcept; /** Sets the amount of saturation in the filter. - @param newValue saturation amount; it can be any number greater than or equal to one. Higher values result in more distortion.*/ + + @param newDrive saturation amount; it can be any number greater than or equal to one. Higher values result in more distortion. + */ void setDrive (SampleType newDrive) noexcept; //==============================================================================