mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
Code Activity

Fixed some doxygen warnings

Browse source
This commit is contained in:
ed 2020-05-18 14:43:50 +01:00
parent a8b6066187
commit 4b6be143cf
3 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

4
modules/juce_audio_processors/utilities/juce_ParameterAttachments.h
View file

@ -45,7 +45,7 @@ public:
@param parameter The parameter to which this attachment will listen @param parameter The parameter to which this attachment will listen
@param parameterChangedCallback The function that will be called on the message thread in response @param parameterChangedCallback The function that will be called on the message thread in response
to parameter changes 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. requests a parameter change.
*/ */
ParameterAttachment (RangedAudioParameter& parameter, ParameterAttachment (RangedAudioParameter& parameter,
@ -209,7 +209,7 @@ public:
/** Creates a connection between a plug-in parameter and a Button. /** Creates a connection between a plug-in parameter and a Button.
@param parameter The parameter to use @param parameter The parameter to use
@param combo The Button to use @param button The Button to use
@param undoManager An optional UndoManager @param undoManager An optional UndoManager
*/ */
ButtonParameterAttachment (RangedAudioParameter& parameter, Button& button, ButtonParameterAttachment (RangedAudioParameter& parameter, Button& button,

6
modules/juce_core/files/juce_DirectoryIterator.h
View file

@ -67,12 +67,6 @@ public:
} }
@endcode @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 @see RangedDirectoryIterator
*/ */
JUCE_DEPRECATED (DirectoryIterator (const File& directory, JUCE_DEPRECATED (DirectoryIterator (const File& directory,

12
modules/juce_dsp/widgets/juce_LadderFilter.h
View file

@ -63,15 +63,21 @@ public:
void reset() noexcept; void reset() noexcept;
/** Sets the cutoff frequency of the filter. /** Sets the cutoff frequency of the filter.
@param newValue cutoff frequency in Hz */
@param newCutoff cutoff frequency in Hz
*/
void setCutoffFrequencyHz (SampleType newCutoff) noexcept; void setCutoffFrequencyHz (SampleType newCutoff) noexcept;
/** Sets the resonance of the filter. /** 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; void setResonance (SampleType newResonance) noexcept;
/** Sets the amount of saturation in the filter. /** 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; void setDrive (SampleType newDrive) noexcept;
//============================================================================== //==============================================================================