Skip to content

Commit f908e52

Browse files
committed
Docs: Align FloatVectorOperations comments with parameter names
1 parent 9a4ab93 commit f908e52

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

modules/juce_audio_basics/buffers/juce_FloatVectorOperations.h

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -77,64 +77,64 @@ struct JUCE_API FloatVectorOperationsBase
7777
/** Copies a vector of floating point numbers, multiplying each value by a given multiplier */
7878
static void JUCE_CALLTYPE copyWithMultiply (FloatType* dest, const FloatType* src, FloatType multiplier, CountType numValues) noexcept;
7979

80-
/** Adds a fixed value to the destination values. */
80+
/** Adds a fixed value to the dest values. */
8181
static void JUCE_CALLTYPE add (FloatType* dest, FloatType amountToAdd, CountType numValues) noexcept;
8282

83-
/** Adds a fixed value to each source value and stores it in the destination array. */
83+
/** Adds a fixed value to each src value and stores it in the dest array. */
8484
static void JUCE_CALLTYPE add (FloatType* dest, const FloatType* src, FloatType amount, CountType numValues) noexcept;
8585

86-
/** Adds the source values to the destination values. */
86+
/** Adds each src value to the corresponding dest value. */
8787
static void JUCE_CALLTYPE add (FloatType* dest, const FloatType* src, CountType numValues) noexcept;
8888

89-
/** Adds each source1 value to the corresponding source2 value and stores the result in the destination array. */
89+
/** Adds each src1 value to the corresponding src2 value and stores the result in the dest array. */
9090
static void JUCE_CALLTYPE add (FloatType* dest, const FloatType* src1, const FloatType* src2, CountType num) noexcept;
9191

92-
/** Subtracts the source values from the destination values. */
92+
/** Subtracts the src values from the dest values. */
9393
static void JUCE_CALLTYPE subtract (FloatType* dest, const FloatType* src, CountType numValues) noexcept;
9494

95-
/** Subtracts each source2 value from the corresponding source1 value and stores the result in the destination array. */
95+
/** Subtracts each src2 value from the corresponding src1 value and stores the result in the dest array. */
9696
static void JUCE_CALLTYPE subtract (FloatType* dest, const FloatType* src1, const FloatType* src2, CountType num) noexcept;
9797

98-
/** Multiplies each source value by the given multiplier, then adds it to the destination value. */
98+
/** Multiplies each src value by the given multiplier, then adds it to the dest value. */
9999
static void JUCE_CALLTYPE addWithMultiply (FloatType* dest, const FloatType* src, FloatType multiplier, CountType numValues) noexcept;
100100

101-
/** Multiplies each source1 value by the corresponding source2 value, then adds it to the destination value. */
101+
/** Multiplies each src1 value by the corresponding src2 value, then adds it to the dest value. */
102102
static void JUCE_CALLTYPE addWithMultiply (FloatType* dest, const FloatType* src1, const FloatType* src2, CountType num) noexcept;
103103

104-
/** Multiplies each source value by the given multiplier, then subtracts it from the destination value. */
104+
/** Multiplies each src value by the given multiplier, then subtracts it from the dest value. */
105105
static void JUCE_CALLTYPE subtractWithMultiply (FloatType* dest, const FloatType* src, FloatType multiplier, CountType numValues) noexcept;
106106

107-
/** Multiplies each source1 value by the corresponding source2 value, then subtracts it from the destination value. */
107+
/** Multiplies each src1 value by the corresponding src2 value, then subtracts it from the dest value. */
108108
static void JUCE_CALLTYPE subtractWithMultiply (FloatType* dest, const FloatType* src1, const FloatType* src2, CountType num) noexcept;
109109

110-
/** Multiplies the destination values by the source values. */
110+
/** Multiplies the dest values by the src values. */
111111
static void JUCE_CALLTYPE multiply (FloatType* dest, const FloatType* src, CountType numValues) noexcept;
112112

113-
/** Multiplies each source1 value by the corresponding source2 value, then stores it in the destination array. */
113+
/** Multiplies each src1 value by the corresponding src2 value, then stores it in the dest array. */
114114
static void JUCE_CALLTYPE multiply (FloatType* dest, const FloatType* src1, const FloatType* src2, CountType numValues) noexcept;
115115

116-
/** Multiplies each of the destination values by a fixed multiplier. */
116+
/** Multiplies each of the dest values by a fixed multiplier. */
117117
static void JUCE_CALLTYPE multiply (FloatType* dest, FloatType multiplier, CountType numValues) noexcept;
118118

119-
/** Multiplies each of the source values by a fixed multiplier and stores the result in the destination array. */
119+
/** Multiplies each of the src values by a fixed multiplier and stores the result in the dest array. */
120120
static void JUCE_CALLTYPE multiply (FloatType* dest, const FloatType* src, FloatType multiplier, CountType num) noexcept;
121121

122-
/** Copies a source vector to a destination, negating each value. */
122+
/** Copies the src vector to dest, negating each value. */
123123
static void JUCE_CALLTYPE negate (FloatType* dest, const FloatType* src, CountType numValues) noexcept;
124124

125-
/** Copies a source vector to a destination, taking the absolute of each value. */
125+
/** Copies the src vector to dest, taking the absolute of each value. */
126126
static void JUCE_CALLTYPE abs (FloatType* dest, const FloatType* src, CountType numValues) noexcept;
127127

128-
/** Each element of dest will be the minimum of the corresponding element of the source array and the given comp value. */
128+
/** Each element of dest will be the minimum of the corresponding element of the src array and the given comp value. */
129129
static void JUCE_CALLTYPE min (FloatType* dest, const FloatType* src, FloatType comp, CountType num) noexcept;
130130

131-
/** Each element of dest will be the minimum of the corresponding source1 and source2 values. */
131+
/** Each element of dest will be the minimum of the corresponding src1 and src2 values. */
132132
static void JUCE_CALLTYPE min (FloatType* dest, const FloatType* src1, const FloatType* src2, CountType num) noexcept;
133133

134-
/** Each element of dest will be the maximum of the corresponding element of the source array and the given comp value. */
134+
/** Each element of dest will be the maximum of the corresponding element of the src array and the given comp value. */
135135
static void JUCE_CALLTYPE max (FloatType* dest, const FloatType* src, FloatType comp, CountType num) noexcept;
136136

137-
/** Each element of dest will be the maximum of the corresponding source1 and source2 values. */
137+
/** Each element of dest will be the maximum of the corresponding src1 and src2 values. */
138138
static void JUCE_CALLTYPE max (FloatType* dest, const FloatType* src1, const FloatType* src2, CountType num) noexcept;
139139

140140
/** Each element of dest is calculated by hard clipping the corresponding src element so that it is in the range specified by the arguments low and high. */

0 commit comments

Comments
 (0)