2323 a higher level function. On the bright side, the chain and
2424 the subsequent EffectProcessor instances will help you store
2525 and restore the bypassing state along with the mix level,
26- and the state of the plugin itse;f .
26+ and the state of the plugin itself .
2727
2828 @see EffectProcessor, EffectProcessorFactory
2929*/
@@ -82,8 +82,8 @@ class EffectProcessorChain final : public InternalProcessor
8282
8383 @param fileOrIdentifier Plugin file or identifier within the KnownPluginList.
8484
85- @returns a new effect processor. This will be nullptr if the index wasn't found
86- or if the plugin failed to load for some reason (eg: debugger is was detected).
85+ @returns a new effect processor. This will be nullptr if the identifier wasn't found
86+ or if the plugin failed to load for some reason (eg: debugger was detected).
8787 */
8888 EffectProcessor::Ptr add (const String& fileOrIdentifier);
8989
@@ -96,7 +96,7 @@ class EffectProcessorChain final : public InternalProcessor
9696 or there will be dangling pointers to the removed plugin!
9797
9898 @returns a new effect processor. This will be nullptr if the index wasn't found
99- or if the plugin failed to load for some reason (eg: debugger is was detected).
99+ or if the plugin failed to load for some reason (eg: debugger was detected).
100100 */
101101 EffectProcessor::Ptr insert (int destinationIndex, int pluginIndex);
102102
@@ -105,11 +105,8 @@ class EffectProcessorChain final : public InternalProcessor
105105 @param destinationIndex Destination in the index of the array of plugins.
106106 @param fileOrIdentifier File or identifier that can be referenced within the KnownPluginList.
107107
108- @warning Callers need to remove plugin editors associated with the current index
109- or there will be dangling pointers to the removed plugin!
110-
111- @returns a new effect processor. This will be nullptr if the index wasn't found
112- or if the plugin failed to load for some reason (eg: debugger is was detected).
108+ @returns a new effect processor. This will be nullptr if the index wasn't valid, tge identifier wasn't found,
109+ or if the plugin failed to load for some reason (eg: debugger was detected).
113110 */
114111 EffectProcessor::Ptr insert (int destinationIndex, const String& fileOrIdentifier);
115112
@@ -121,8 +118,8 @@ class EffectProcessorChain final : public InternalProcessor
121118 @warning Callers need to remove plugin editors associated with the current index
122119 or there will be dangling pointers to the removed plugin!
123120
124- @returns a new effect processor. This will be nullptr if the index wasn't found
125- or if the plugin failed to load for some reason (eg: debugger is was detected).
121+ @returns a new effect processor. This will be nullptr if the index wasn't valid
122+ or if the plugin failed to load for some reason (eg: debugger was detected).
126123 */
127124 EffectProcessor::Ptr replace (int destinationIndex, int pluginIndex);
128125
@@ -134,8 +131,8 @@ class EffectProcessorChain final : public InternalProcessor
134131 @warning Callers need to remove plugin editors associated with the current index
135132 or there will be dangling pointers to the removed plugin!
136133
137- @returns a new effect processor. This will be nullptr if the index wasn't found
138- or if the plugin failed to load for some reason (eg: debugger is was detected).
134+ @returns a new effect processor. This will be nullptr if the index wasn't valid
135+ or if the plugin failed to load for some reason (eg: debugger was detected).
139136 */
140137 EffectProcessor::Ptr replace (int destinationIndex, const String& fileOrIdentifier);
141138
@@ -144,15 +141,13 @@ class EffectProcessorChain final : public InternalProcessor
144141
145142 @param sourceIndex Plugin index within the array of plugins.
146143 @param destinationIndex Destination in the index of the array of plugins.
147-
148- @returns true if the action was successful.
149144 */
150145 void move (int sourceIndex, int destinationIndex);
151146
152147 /* * Swaps a pair of effects in the chain.
153148
154- If either of the indexes passed in is out-of-range, nothing will happen,
155- otherwise the two effects at these positions will be exchanged.
149+ If either of the indexes passed in are out-of-range, nothing will happen;
150+ otherwise, the two effects at these positions will be exchanged.
156151 */
157152 void swap (int index1, int index2);
158153
0 commit comments