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

Documentation fixes

Browse source
This commit is contained in:
tpoole 2017-07-31 18:54:07 +01:00
parent 9206f8819f
commit 77dd64abfa
8 changed files with 44 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doxygen/Doxyfile
View file

@ -838,7 +838,9 @@ EXCLUDE = ../modules/juce_graphics/image_formats \
../modules/juce_tracktion_marketplace/juce_tracktion_marketplace.h \
../modules/juce_video/juce_video.h \
../modules/juce_video/juce_video.cpp \
../modules/juce_video/native
../modules/juce_video/native \
../modules/juce_dsp/juce_dsp.h \
../modules/juce_dsp/juce_dsp.cpp
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded

12
modules/juce_audio_basics/effects/juce_LinearSmoothedValue.h
View file

@ -108,7 +108,7 @@ public:
@param samples Pointer to a raw array of samples
@param numSamples Length of array of samples
*/
void applyGain (FloatType *samples, int numSamples) noexcept
void applyGain (FloatType* samples, int numSamples) noexcept
{
jassert(numSamples >= 0);
@ -126,11 +126,11 @@ public:
//==============================================================================
/** Computes output as linear smoothed gain applied to a stream of samples.
Sout[i] = Sin[i] * gain
@param samples Pointer to a raw array of samples
@param numSamples Length of sample array
@param numSamples Length of array of samples
@param samplesOut A pointer to a raw array of output samples
@param samplesIn A pointer to a raw array of input samples
@param numSamples The length of the array of samples
*/
void applyGain (FloatType *samplesOut, const FloatType *samplesIn, int numSamples) noexcept
void applyGain (FloatType* samplesOut, const FloatType* samplesIn, int numSamples) noexcept
{
jassert (numSamples >= 0);
@ -155,7 +155,7 @@ public:
{
if (buffer.getNumChannels() == 1)
{
FloatType *samples = buffer.getWritePointer(0);
FloatType* samples = buffer.getWritePointer(0);
for (int i = 0; i < numSamples; i++)
samples[i] *= getNextValue();

20
modules/juce_audio_formats/format/juce_AudioFormatWriter.h
View file

@ -65,16 +65,16 @@ protected:
//==============================================================================
/** Creates an AudioFormatWriter object.
@param destStream the stream to write to - this will be deleted
by this object when it is no longer needed
@param formatName the description that will be returned by the getFormatName()
method
@param sampleRate the sample rate to use - the base class just stores
this value, it doesn't do anything with it
@param channelLayout the channel layout to use for the writer - the base class
just stores this value, it doesn't do anything with it
@param bitsPerSample the bit depth of the stream - the base class just stores
this value, it doesn't do anything with it
@param destStream the stream to write to - this will be deleted
by this object when it is no longer needed
@param formatName the description that will be returned by the getFormatName()
method
@param sampleRate the sample rate to use - the base class just stores
this value, it doesn't do anything with it
@param audioChannelLayout the channel layout to use for the writer - the base class
just stores this value, it doesn't do anything with it
@param bitsPerSample the bit depth of the stream - the base class just stores
this value, it doesn't do anything with it
*/
AudioFormatWriter (OutputStream* destStream,
const String& formatName,

4
modules/juce_dsp/containers/juce_AudioBlock.h
View file

@ -171,8 +171,8 @@ public:
}
/** Returns a subset of continguous channels
@param channelStart First channel of the subset
@param channelCount Count of channels in the subset
@param channelStart First channel of the subset
@param numChannelsToUse Count of channels in the subset
*/
forcedinline AudioBlock<SampleType> getSubsetChannelBlock (size_t channelStart, size_t numChannelsToUse) noexcept
{

2
modules/juce_dsp/frequency/juce_Convolution.h
View file

@ -39,7 +39,7 @@
efficient in general to do frequency domain convolution when the size of
the impulse response is higher than 64 samples.
see @FIRFilter, @FIRFilter::Coefficients, @FFT
@see FIRFilter, FIRFilter::Coefficients, FFT
*/
class JUCE_API Convolution
{

28
modules/juce_dsp/maths/juce_LookupTable.h
View file

@ -187,7 +187,7 @@ public:
fail for values lower than this.
@param maxInputValueToUse The highest input value used. The approximation will
fail for values higher than this.
@param numPointsToUse The number of pre-calculated values stored.
@param numPoints The number of pre-calculated values stored.
*/
LookupTableTransform (const std::function<FloatType (FloatType)>& functionToApproximate,
FloatType minInputValueToUse,
@ -206,7 +206,7 @@ public:
fail for values lower than this.
@param maxInputValueToUse The highest input value used. The approximation will
fail for values higher than this.
@param numPointsToUse The number of pre-calculated values stored.
@param numPoints The number of pre-calculated values stored.
*/
void initialise (const std::function<FloatType (FloatType)>& functionToApproximate,
FloatType minInputValueToUse,
@ -280,19 +280,27 @@ public:
}
//==============================================================================
/** Calculates the maximum relative error of the approximation for the specified parameter set.
/** Calculates the maximum relative error of the approximation for the specified
parameter set.
The closer the returned value is to zero the more accurate the approximation is.
The closer the returned value is to zero the more accurate the approximation
is.
This function compares the approximated output of this class to the function
it approximates at a range of points and returns the maximum relative error.
This can be used to determine if the approximatiokn is suitable for the given
problem. The accuracy of the approximation can generally be improved by increasing
numPoints.
This can be used to determine if the approximation is suitable for the given
problem. The accuracy of the approximation can generally be improved by
increasing numPoints.
@param numTestPoints The number of input values used for error calculation.
Higher numbers can increase the accuracy of the error
calculation. If it's zero 100 * numPoints will be used.
@param functionToApproximate The approximated function. This should be a
mapping from a FloatType to FloatType.
@param minInputValue The lowest input value used.
@param maxInputValue The highest input value used.
@param numPoints The number of pre-calculated values stored.
@param numTestPoints The number of input values used for error
calculation. Higher numbers can increase the
accuracy of the error calculation. If it's zero
then 100 * numPoints will be used.
*/
static double calculateMaxRelativeError (const std::function<FloatType (FloatType)>& functionToApproximate,
FloatType minInputValue,

2
modules/juce_dsp/processors/juce_IIRFilter.h
View file

@ -42,7 +42,7 @@ namespace IIR
which is designed to prevent artefacts at parameter changes, instead of the
class Filter.
@see Filter::Coefficients, FilterAudioSource, @StateVariableFilter
@see Filter::Coefficients, FilterAudioSource, StateVariableFilter
*/
template <typename SampleType>
class Filter

3
modules/juce_dsp/processors/juce_IIRFilter_Impl.h
View file

@ -24,6 +24,7 @@
==============================================================================
*/
#ifndef DOXYGEN
template <typename Type>
struct SnapToZeroHelper
@ -230,3 +231,5 @@ void Filter<SampleType>::check()
if (order != coefficients->getFilterOrder())
reset();
}
#endif