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

Documentation fixes

This commit is contained in:
tpoole 2017-08-01 11:22:55 +01:00
parent 9d692d0d8b
commit 6e818d42f4
8 changed files with 60 additions and 50 deletions

View file

@ -420,13 +420,13 @@ public:
return *this;
}
/* negates each value of the receiver */
/** Negates each value of the receiver. */
forcedinline AudioBlock& negate() noexcept
{
return multiply (static_cast<SampleType> (-1.0));
}
/* Negates each value of source and stores it in the receiver */
/** Negates each value of source and stores it in the receiver. */
forcedinline AudioBlock& replaceWithNegativeOf (const AudioBlock& src) noexcept
{
jassert (numChannels == src.numChannels);
@ -438,7 +438,7 @@ public:
return *this;
}
/* takes the absolute value of each element of src and stores it inside the receiver. */
/** Takes the absolute value of each element of src and stores it inside the receiver. */
forcedinline AudioBlock& replaceWithAbsoluteValueOf (const AudioBlock& src) noexcept
{
jassert (numChannels == src.numChannels);
@ -462,7 +462,7 @@ public:
return *this;
}
/** Each element of receiver will be the maximum of the corresponding element of the source arrays. */
/** Each element of the receiver will be the maximum of the corresponding element of the source arrays. */
forcedinline AudioBlock& max (AudioBlock src1, AudioBlock src2) noexcept
{
jassert (numChannels == src1.numChannels && src1.numChannels == src2.numChannels);
@ -474,7 +474,7 @@ public:
return *this;
}
/** Find minimum and maximum value of the buffer. */
/** Finds the minimum and maximum value of the buffer. */
forcedinline Range<NumericType> findMinAndMax() const noexcept
{
Range<NumericType> minmax;