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

Docs: Replace doxygen preprocessor conditionals with @cond and @endconds

This commit is contained in:
Anthony Nicholls 2025-07-18 09:59:35 +01:00 committed by Sudara
parent 26e8d81380
commit 36d07a6ce3
136 changed files with 420 additions and 449 deletions

View file

@ -118,7 +118,7 @@ public:
*/
HostedParameter* getHostedParameter (int index) const;
#ifndef DOXYGEN
/** @cond */
/** Use the new typesafe visitor-based interface rather than this function.
Returns a pointer to some kind of platform-specific data about the plugin.
@ -150,7 +150,7 @@ public:
[[deprecated]] bool isParameterOrientationInverted (int parameterIndex) const override;
[[deprecated]] bool isMetaParameter (int parameterIndex) const override;
[[deprecated]] AudioProcessorParameter::Category getParameterCategory (int parameterIndex) const override;
#endif
/** @endcond */
protected:
//==============================================================================

View file

@ -1487,7 +1487,7 @@ protected:
void sendParamChangeMessageToListeners (int parameterIndex, float newValue);
public:
#ifndef DOXYGEN
/** @cond */
// These methods are all deprecated in favour of using AudioProcessorParameter
// and AudioProcessorParameterGroup
[[deprecated]] virtual int getNumParameters();
@ -1520,7 +1520,7 @@ public:
[[deprecated]] virtual const String getOutputChannelName (int channelIndex) const;
[[deprecated]] virtual bool isInputChannelStereoPair (int index) const;
[[deprecated]] virtual bool isOutputChannelStereoPair (int index) const;
#endif
/** @endcond */
private:
//==============================================================================

View file

@ -235,13 +235,13 @@ public:
addChild (std::forward<Args> (remainingChildren)...);
}
#ifndef DOXYGEN
/** @cond */
[[deprecated ("This class now has a move operator, so if you're trying to move them around, you "
"should use that, or if you really need to swap two groups, just call std::swap. "
"However, remember that swapping a group that's already owned by an AudioProcessor "
"will most likely crash the host, so don't do that.")]]
void swapWith (AudioProcessorParameterGroup& other) { std::swap (*this, other); }
#endif
/** @endcond */
private:
//==============================================================================

View file

@ -58,10 +58,10 @@ public:
void paint (Graphics&) override;
void resized() override;
#ifndef DOXYGEN
/** @cond */
[[deprecated ("This constructor has been changed to take a reference instead of a pointer.")]]
GenericAudioProcessorEditor (AudioProcessor* p) : GenericAudioProcessorEditor (*p) {}
#endif
/** @endcond */
private:
//==============================================================================