diff --git a/modules/juce_analytics/analytics/juce_Analytics.h b/modules/juce_analytics/analytics/juce_Analytics.h index 57c728fd86..fc65ee8ffd 100644 --- a/modules/juce_analytics/analytics/juce_Analytics.h +++ b/modules/juce_analytics/analytics/juce_Analytics.h @@ -103,9 +103,9 @@ public: */ void setSuspended (bool shouldBeSuspended); - #ifndef DOXYGEN + /** @cond */ JUCE_DECLARE_SINGLETON_INLINE (Analytics, false) - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_audio_basics/buffers/juce_AudioDataConverters.h b/modules/juce_audio_basics/buffers/juce_AudioDataConverters.h index 966380603a..a63ac17564 100644 --- a/modules/juce_audio_basics/buffers/juce_AudioDataConverters.h +++ b/modules/juce_audio_basics/buffers/juce_AudioDataConverters.h @@ -76,8 +76,9 @@ public: class NonConst; /**< Used as a template parameter for AudioData::Pointer. Indicates that the pointer can be used for non-const data. */ class Const; /**< Used as a template parameter for AudioData::Pointer. Indicates that the samples can only be used for const data.. */ - #ifndef DOXYGEN + //============================================================================== + /** @cond */ class BigEndian { public: @@ -332,7 +333,7 @@ public: static void* toVoidPtr (VoidType* v) noexcept { return const_cast (v); } enum { isConst = 1 }; }; - #endif + /** @endcond */ //============================================================================== /** @@ -799,7 +800,7 @@ public: }; //============================================================================== -#ifndef DOXYGEN +/** @cond */ /** A set of routines to convert buffers of 32-bit floating point data to and from various integer formats. @@ -867,6 +868,6 @@ public: private: AudioDataConverters(); }; -#endif +/** @endcond */ } // namespace juce diff --git a/modules/juce_audio_basics/buffers/juce_FloatVectorOperations.h b/modules/juce_audio_basics/buffers/juce_FloatVectorOperations.h index 427783d6f7..ec7140ce9c 100644 --- a/modules/juce_audio_basics/buffers/juce_FloatVectorOperations.h +++ b/modules/juce_audio_basics/buffers/juce_FloatVectorOperations.h @@ -150,7 +150,7 @@ struct JUCE_API FloatVectorOperationsBase static FloatType JUCE_CALLTYPE findMaximum (const FloatType* src, CountType numValues) noexcept; }; -#if ! DOXYGEN +/** @cond */ namespace detail { @@ -177,7 +177,7 @@ struct NameForwarder : public Bases... }; } // namespace detail -#endif +/** @endcond */ //============================================================================== /** diff --git a/modules/juce_audio_basics/midi/juce_MidiBuffer.h b/modules/juce_audio_basics/midi/juce_MidiBuffer.h index 7b6a17b06c..32a0283236 100644 --- a/modules/juce_audio_basics/midi/juce_MidiBuffer.h +++ b/modules/juce_audio_basics/midi/juce_MidiBuffer.h @@ -285,7 +285,7 @@ public: MidiBufferIterator findNextSamplePosition (int samplePosition) const noexcept; //============================================================================== - #ifndef DOXYGEN + /** @cond */ /** This class is now deprecated in favour of MidiBufferIterator. Used to iterate through the events in a MidiBuffer. @@ -342,7 +342,7 @@ public: const MidiBuffer& buffer; MidiBufferIterator iterator; }; - #endif + /** @endcond */ /** The raw data holding this buffer. Obviously access to this data is provided at your own risk. Its internal format could diff --git a/modules/juce_audio_basics/midi/juce_MidiMessage.h b/modules/juce_audio_basics/midi/juce_MidiMessage.h index 2288cd27f7..0e8bcd61af 100644 --- a/modules/juce_audio_basics/midi/juce_MidiMessage.h +++ b/modules/juce_audio_basics/midi/juce_MidiMessage.h @@ -880,7 +880,7 @@ public: static MidiMessage createSysExMessage (Span data); //============================================================================== - #ifndef DOXYGEN + /** @cond */ /** Reads a midi variable-length integer. The `data` argument indicates the data to read the number from, @@ -889,7 +889,7 @@ public: */ [[deprecated ("This signature has been deprecated in favour of the safer readVariableLengthValue.")]] static int readVariableLengthVal (const uint8* data, int& numBytesUsed) noexcept; - #endif + /** @endcond */ /** Holds information about a variable-length value which was parsed from a stream of bytes. @@ -989,17 +989,17 @@ public: private: //============================================================================== - #ifndef DOXYGEN + /** @cond */ union PackedData { uint8* allocatedData; uint8 asBytes[sizeof (uint8*)]; }; + /** @endcond */ PackedData packedData; double timeStamp = 0; int size; - #endif inline bool isHeapAllocated() const noexcept { return size > (int) sizeof (packedData); } inline uint8* getData() const noexcept { return isHeapAllocated() ? packedData.allocatedData : (uint8*) packedData.asBytes; } diff --git a/modules/juce_audio_basics/midi/ump/juce_UMP.h b/modules/juce_audio_basics/midi/ump/juce_UMP.h index 1c1c807a1f..ea1e53a325 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMP.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMP.h @@ -47,11 +47,9 @@ #include "juce_UMPDispatcher.h" #include "juce_UMPReceiver.h" -#ifndef DOXYGEN - +/** @cond */ namespace juce { namespace ump = universal_midi_packets; } - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPConversion.h b/modules/juce_audio_basics/midi/ump/juce_UMPConversion.h index 0cafc1cb7d..859c9a0d7d 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPConversion.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPConversion.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -363,5 +362,4 @@ struct Conversion }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPConverters.h b/modules/juce_audio_basics/midi/ump/juce_UMPConverters.h index 7f17a4bce4..38d5bee49c 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPConverters.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPConverters.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { /** @@ -193,5 +192,4 @@ namespace juce::universal_midi_packets Midi1ToBytestreamTranslator translator; }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPDispatcher.h b/modules/juce_audio_basics/midi/ump/juce_UMPDispatcher.h index ffc5b355f0..f0e5ff11bb 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPDispatcher.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPDispatcher.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -199,5 +198,4 @@ private: }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPFactory.h b/modules/juce_audio_basics/midi/ump/juce_UMPFactory.h index 29761f7f01..94f7fac179 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPFactory.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPFactory.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -539,5 +538,4 @@ struct Factory }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPIterator.h b/modules/juce_audio_basics/midi/ump/juce_UMPIterator.h index 26e8eef1c5..ea042b6934 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPIterator.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPIterator.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -128,5 +127,4 @@ private: }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPMidi1ToBytestreamTranslator.h b/modules/juce_audio_basics/midi/ump/juce_UMPMidi1ToBytestreamTranslator.h index f7e7643296..b53d3c7263 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPMidi1ToBytestreamTranslator.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPMidi1ToBytestreamTranslator.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -223,5 +222,4 @@ private: }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPMidi1ToMidi2DefaultTranslator.h b/modules/juce_audio_basics/midi/ump/juce_UMPMidi1ToMidi2DefaultTranslator.h index 49908f946d..96eef2850a 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPMidi1ToMidi2DefaultTranslator.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPMidi1ToMidi2DefaultTranslator.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -196,5 +195,4 @@ private: }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPProtocols.h b/modules/juce_audio_basics/midi/ump/juce_UMPProtocols.h index 706fb0248c..1770c0c52e 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPProtocols.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPProtocols.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -53,5 +52,4 @@ enum class MidiProtocol }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPReceiver.h b/modules/juce_audio_basics/midi/ump/juce_UMPReceiver.h index 3bca045063..96e6b859d2 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPReceiver.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPReceiver.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -51,5 +50,4 @@ struct Receiver }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPSysEx7.h b/modules/juce_audio_basics/midi/ump/juce_UMPSysEx7.h index 29ee563642..39deca2ce6 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPSysEx7.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPSysEx7.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -82,5 +81,4 @@ struct SysEx7 }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPUtils.h b/modules/juce_audio_basics/midi/ump/juce_UMPUtils.h index e417bc176d..0e2b8794be 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPUtils.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPUtils.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -125,5 +124,4 @@ struct Utils }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPView.h b/modules/juce_audio_basics/midi/ump/juce_UMPView.h index c919fea390..2fd47306ca 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPView.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPView.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -97,5 +96,4 @@ private: }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPacket.h b/modules/juce_audio_basics/midi/ump/juce_UMPacket.h index 214202291c..9b319bcac8 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPacket.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPacket.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -198,5 +197,4 @@ using PacketX3 = Packet<3>; using PacketX4 = Packet<4>; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/midi/ump/juce_UMPackets.h b/modules/juce_audio_basics/midi/ump/juce_UMPackets.h index 67f5a6bded..5fed8f4290 100644 --- a/modules/juce_audio_basics/midi/ump/juce_UMPackets.h +++ b/modules/juce_audio_basics/midi/ump/juce_UMPackets.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -101,5 +100,4 @@ private: }; } // namespace juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h b/modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h index 312afe8281..d50111fcac 100644 --- a/modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h +++ b/modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h @@ -226,9 +226,9 @@ public: /** Removes a listener. */ void removeListener (Listener* const listenerToRemove) noexcept; - #ifndef DOXYGEN + /** @cond */ using Zone = MPEZone; - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_audio_basics/native/juce_CoreAudioLayouts_mac.h b/modules/juce_audio_basics/native/juce_CoreAudioLayouts_mac.h index 5e234d9f6e..ed4fb9e632 100644 --- a/modules/juce_audio_basics/native/juce_CoreAudioLayouts_mac.h +++ b/modules/juce_audio_basics/native/juce_CoreAudioLayouts_mac.h @@ -32,10 +32,11 @@ ============================================================================== */ +/** @cond */ namespace juce { -#if ! defined (DOXYGEN) && (JUCE_MAC || JUCE_IOS) +#if JUCE_MAC || JUCE_IOS struct CoreAudioLayouts { @@ -361,3 +362,4 @@ private: #endif } // namespace juce +/** @endcond */ diff --git a/modules/juce_audio_basics/native/juce_CoreAudioTimeConversions_mac.h b/modules/juce_audio_basics/native/juce_CoreAudioTimeConversions_mac.h index b9e63c882f..c7f72d59d7 100644 --- a/modules/juce_audio_basics/native/juce_CoreAudioTimeConversions_mac.h +++ b/modules/juce_audio_basics/native/juce_CoreAudioTimeConversions_mac.h @@ -36,7 +36,7 @@ // This file will be included directly by macOS/iOS-specific .cpps #pragma once -#if ! DOXYGEN +/** @cond */ #include @@ -89,4 +89,4 @@ private: } // namespace juce -#endif +/** @endcond */ diff --git a/modules/juce_audio_basics/utilities/juce_SmoothedValue.h b/modules/juce_audio_basics/utilities/juce_SmoothedValue.h index 474c5856a3..b2412a0ba3 100644 --- a/modules/juce_audio_basics/utilities/juce_SmoothedValue.h +++ b/modules/juce_audio_basics/utilities/juce_SmoothedValue.h @@ -342,7 +342,7 @@ public: } //============================================================================== - #ifndef DOXYGEN + /** @cond */ /** Using the new methods: lsv.setValue (x, false); -> lsv.setTargetValue (x); @@ -362,7 +362,7 @@ public: setTargetValue (newValue); } - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_audio_devices/audio_io/juce_AudioDeviceManager.h b/modules/juce_audio_devices/audio_io/juce_AudioDeviceManager.h index 2cb0bf9c5a..4c1e6e5171 100644 --- a/modules/juce_audio_devices/audio_io/juce_AudioDeviceManager.h +++ b/modules/juce_audio_devices/audio_io/juce_AudioDeviceManager.h @@ -486,7 +486,7 @@ public: int getXRunCount() const noexcept; //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("Use setMidiInputDeviceEnabled instead.")]] void setMidiInputEnabled (const String&, bool); [[deprecated ("Use isMidiInputDeviceEnabled instead.")]] @@ -499,7 +499,7 @@ public: void setDefaultMidiOutput (const String&); [[deprecated ("Use getDefaultMidiOutputIdentifier instead.")]] const String& getDefaultMidiOutputName() const noexcept { return defaultMidiOutputDeviceInfo.name; } - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_audio_devices/audio_io/juce_AudioIODeviceType.h b/modules/juce_audio_devices/audio_io/juce_AudioIODeviceType.h index bd117ca3d9..662588a6fd 100644 --- a/modules/juce_audio_devices/audio_io/juce_AudioIODeviceType.h +++ b/modules/juce_audio_devices/audio_io/juce_AudioIODeviceType.h @@ -179,10 +179,10 @@ public: /** Creates a Bela device type if it's available on this platform, or returns null. */ static AudioIODeviceType* createAudioIODeviceType_Bela(); - #ifndef DOXYGEN + /** @cond */ [[deprecated ("You should call the method which takes a WASAPIDeviceMode instead.")]] static AudioIODeviceType* createAudioIODeviceType_WASAPI (bool exclusiveMode); - #endif + /** @endcond */ protected: explicit AudioIODeviceType (const String& typeName); diff --git a/modules/juce_audio_devices/midi_io/juce_MidiDevices.h b/modules/juce_audio_devices/midi_io/juce_MidiDevices.h index b22de5a884..b7ba68d01b 100644 --- a/modules/juce_audio_devices/midi_io/juce_MidiDevices.h +++ b/modules/juce_audio_devices/midi_io/juce_MidiDevices.h @@ -251,14 +251,14 @@ public: void setName (const String& newName) noexcept { deviceInfo.name = newName; } //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("Use getAvailableDevices instead.")]] static StringArray getDevices(); [[deprecated ("Use getDefaultDevice instead.")]] static int getDefaultDeviceIndex(); [[deprecated ("Use openDevice that takes a device identifier instead.")]] static std::unique_ptr openDevice (int, MidiInputCallback*); - #endif + /** @endcond */ /** @internal */ class Pimpl; @@ -440,14 +440,14 @@ public: bool isBackgroundThreadRunning() const noexcept { return isThreadRunning(); } //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("Use getAvailableDevices instead.")]] static StringArray getDevices(); [[deprecated ("Use getDefaultDevice instead.")]] static int getDefaultDeviceIndex(); [[deprecated ("Use openDevice that takes a device identifier instead.")]] static std::unique_ptr openDevice (int); - #endif + /** @endcond */ /** @internal */ class Pimpl; diff --git a/modules/juce_audio_devices/midi_io/ump/juce_UMPBytestreamInputHandler.h b/modules/juce_audio_devices/midi_io/ump/juce_UMPBytestreamInputHandler.h index 31084c6c33..54fd6b5f1e 100644 --- a/modules/juce_audio_devices/midi_io/ump/juce_UMPBytestreamInputHandler.h +++ b/modules/juce_audio_devices/midi_io/ump/juce_UMPBytestreamInputHandler.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -149,5 +148,4 @@ struct BytestreamToUMPHandler : public BytestreamInputHandler }; } // juce::universal_midi_packets - -#endif +/** @endcond */ diff --git a/modules/juce_audio_devices/midi_io/ump/juce_UMPU32InputHandler.h b/modules/juce_audio_devices/midi_io/ump/juce_UMPU32InputHandler.h index 8c8145cfdf..4933524e21 100644 --- a/modules/juce_audio_devices/midi_io/ump/juce_UMPU32InputHandler.h +++ b/modules/juce_audio_devices/midi_io/ump/juce_UMPU32InputHandler.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce::universal_midi_packets { @@ -160,6 +159,4 @@ struct U32ToUMPHandler : public U32InputHandler }; } // namespace juce::universal_midi_packets - - -#endif +/** @endcond */ diff --git a/modules/juce_audio_processors/format_types/LV2_SDK/generate_lv2_bundle_sources.py b/modules/juce_audio_processors/format_types/LV2_SDK/generate_lv2_bundle_sources.py index ca906075ec..f31b73d5b4 100644 --- a/modules/juce_audio_processors/format_types/LV2_SDK/generate_lv2_bundle_sources.py +++ b/modules/juce_audio_processors/format_types/LV2_SDK/generate_lv2_bundle_sources.py @@ -97,7 +97,7 @@ FUNCTION_TEMPLATE = """/* #pragma once -#ifndef DOXYGEN +/** @cond */ #include @@ -130,7 +130,7 @@ std::vector juce::lv2::Bundle::getAllBundles() }}; }} -#endif""" +/** @endcond */""" def chunks(lst, n): diff --git a/modules/juce_audio_processors/format_types/juce_AU_Shared.h b/modules/juce_audio_processors/format_types/juce_AU_Shared.h index 9c7f6cbc48..11ed907270 100644 --- a/modules/juce_audio_processors/format_types/juce_AU_Shared.h +++ b/modules/juce_audio_processors/format_types/juce_AU_Shared.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ // This macro can be set if you need to override this internal name for some reason.. #ifndef JUCE_STATE_DICTIONARY_KEY #define JUCE_STATE_DICTIONARY_KEY "jucePluginState" @@ -717,5 +716,4 @@ struct AudioUnitHelpers }; } // namespace juce - -#endif +/** @endcond */ diff --git a/modules/juce_audio_processors/format_types/juce_LV2Common.h b/modules/juce_audio_processors/format_types/juce_LV2Common.h index 10a64b8ef0..051ebc15fe 100644 --- a/modules/juce_audio_processors/format_types/juce_LV2Common.h +++ b/modules/juce_audio_processors/format_types/juce_LV2Common.h @@ -34,7 +34,7 @@ #pragma once -#ifndef DOXYGEN +/** @cond */ #include "juce_lv2_config.h" @@ -672,5 +672,4 @@ static inline String sanitiseStringAsTtlName (const String& input) } } // namespace juce::lv2_shared - -#endif +/** @endcond */ diff --git a/modules/juce_audio_processors/format_types/juce_LV2Resources.h b/modules/juce_audio_processors/format_types/juce_LV2Resources.h index c560973bc8..834cf3143a 100644 --- a/modules/juce_audio_processors/format_types/juce_LV2Resources.h +++ b/modules/juce_audio_processors/format_types/juce_LV2Resources.h @@ -38,7 +38,7 @@ #pragma once -#ifndef DOXYGEN +/** @cond */ #include @@ -10238,4 +10238,4 @@ to an instance of LV2_Extension_Data_Feature. }; } -#endif +/** @endcond */ diff --git a/modules/juce_audio_processors/format_types/juce_VST3Common.h b/modules/juce_audio_processors/format_types/juce_VST3Common.h index 107f61321f..98623188b5 100644 --- a/modules/juce_audio_processors/format_types/juce_VST3Common.h +++ b/modules/juce_audio_processors/format_types/juce_VST3Common.h @@ -34,8 +34,7 @@ #pragma once -#ifndef DOXYGEN - +/** @cond */ namespace juce { @@ -1663,5 +1662,4 @@ private: JUCE_END_NO_SANITIZE } // namespace juce - -#endif +/** @endcond */ diff --git a/modules/juce_audio_processors/format_types/juce_VST3PluginFormat.h b/modules/juce_audio_processors/format_types/juce_VST3PluginFormat.h index c9e7ec3d81..f0af5ea98f 100644 --- a/modules/juce_audio_processors/format_types/juce_VST3PluginFormat.h +++ b/modules/juce_audio_processors/format_types/juce_VST3PluginFormat.h @@ -52,7 +52,7 @@ public: ~VST3PluginFormat() override; //============================================================================== - #ifndef DOXYGEN + /** @cond */ /** Attempts to reload a VST3 plugin's state from some preset file data. @see VSTPluginFormat::loadFromFXBFile @@ -62,7 +62,7 @@ public: "Then, call ExtensionsVisitor::VST3::setPreset() to set the state using the " "contents of a vstpreset file.")]] static bool setStateFromVSTPresetFile (AudioPluginInstance*, const MemoryBlock&); - #endif + /** @endcond */ //============================================================================== static String getFormatName() { return "VST3"; } diff --git a/modules/juce_audio_processors/format_types/juce_VST3Utilities.h b/modules/juce_audio_processors/format_types/juce_VST3Utilities.h index a8782c570c..14867972b0 100644 --- a/modules/juce_audio_processors/format_types/juce_VST3Utilities.h +++ b/modules/juce_audio_processors/format_types/juce_VST3Utilities.h @@ -34,8 +34,7 @@ #pragma once -#ifndef DOXYGEN - +/** @cond */ namespace juce { @@ -239,5 +238,4 @@ auto becomeVSTComSmartPtrOwner (ObjectType* t) JUCE_END_NO_SANITIZE } // namespace juce - -#endif // DOXYGEN +/** @endcond */ diff --git a/modules/juce_audio_processors/processors/juce_AudioPluginInstance.h b/modules/juce_audio_processors/processors/juce_AudioPluginInstance.h index 234e02c5ea..2f70906db4 100644 --- a/modules/juce_audio_processors/processors/juce_AudioPluginInstance.h +++ b/modules/juce_audio_processors/processors/juce_AudioPluginInstance.h @@ -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: //============================================================================== diff --git a/modules/juce_audio_processors/processors/juce_AudioProcessor.h b/modules/juce_audio_processors/processors/juce_AudioProcessor.h index 0b8cb7e785..00df5b2f7b 100644 --- a/modules/juce_audio_processors/processors/juce_AudioProcessor.h +++ b/modules/juce_audio_processors/processors/juce_AudioProcessor.h @@ -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: //============================================================================== diff --git a/modules/juce_audio_processors/processors/juce_AudioProcessorParameterGroup.h b/modules/juce_audio_processors/processors/juce_AudioProcessorParameterGroup.h index 0a888bdcd2..b5a4b6b75e 100644 --- a/modules/juce_audio_processors/processors/juce_AudioProcessorParameterGroup.h +++ b/modules/juce_audio_processors/processors/juce_AudioProcessorParameterGroup.h @@ -235,13 +235,13 @@ public: addChild (std::forward (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: //============================================================================== diff --git a/modules/juce_audio_processors/processors/juce_GenericAudioProcessorEditor.h b/modules/juce_audio_processors/processors/juce_GenericAudioProcessorEditor.h index 13df38ca2e..5830c75282 100644 --- a/modules/juce_audio_processors/processors/juce_GenericAudioProcessorEditor.h +++ b/modules/juce_audio_processors/processors/juce_GenericAudioProcessorEditor.h @@ -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: //============================================================================== diff --git a/modules/juce_audio_processors/scanning/juce_KnownPluginList.h b/modules/juce_audio_processors/scanning/juce_KnownPluginList.h index 98148a3027..1bda8ad0ca 100644 --- a/modules/juce_audio_processors/scanning/juce_KnownPluginList.h +++ b/modules/juce_audio_processors/scanning/juce_KnownPluginList.h @@ -218,7 +218,7 @@ public: void setCustomScanner (std::unique_ptr newScanner); //============================================================================== - #ifndef DOXYGEN + /** @cond */ // These methods have been deprecated! When getting the list of plugin types you should instead use // the getTypes() method which returns a copy of the internal PluginDescription array and can be accessed // in a thread-safe way. @@ -234,7 +234,7 @@ public: [[deprecated]] void addToMenu (PopupMenu& menu, SortMethod sortMethod, const String& currentlyTickedPluginID = {}) const; [[deprecated]] int getIndexChosenByMenu (int menuResultCode) const; [[deprecated]] std::unique_ptr createTree (SortMethod sortMethod) const; - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_audio_processors/utilities/ARA/juce_ARADebug.h b/modules/juce_audio_processors/utilities/ARA/juce_ARADebug.h index 370b2b3852..43231d96ef 100644 --- a/modules/juce_audio_processors/utilities/ARA/juce_ARADebug.h +++ b/modules/juce_audio_processors/utilities/ARA/juce_ARADebug.h @@ -36,9 +36,11 @@ #include -#if ! (defined (JUCE_API) || defined (DOXYGEN)) - #define JUCE_API +/** @cond */ +#ifndef JUCE_API + #define JUCE_API #endif +/** @endcond */ #if (JucePlugin_Enable_ARA || (JUCE_PLUGINHOST_ARA && (JUCE_PLUGINHOST_VST3 || JUCE_PLUGINHOST_AU))) && (JUCE_MAC || JUCE_WINDOWS || JUCE_LINUX) diff --git a/modules/juce_audio_processors/utilities/ARA/juce_ARADocumentController.cpp b/modules/juce_audio_processors/utilities/ARA/juce_ARADocumentController.cpp index a22b27c353..79927fb607 100644 --- a/modules/juce_audio_processors/utilities/ARA/juce_ARADocumentController.cpp +++ b/modules/juce_audio_processors/utilities/ARA/juce_ARADocumentController.cpp @@ -141,8 +141,7 @@ protected: void doRequestProcessingAlgorithmForAudioSource (ARA::PlugIn::AudioSource* audioSource, ARA::ARAInt32 algorithmIndex) noexcept override; -#ifndef DOXYGEN - + /** @cond */ //============================================================================== bool doRestoreObjectsFromArchive (ARA::PlugIn::HostArchiveReader* archiveReader, const ARA::PlugIn::RestoreObjectsFilter* filter) noexcept override; bool doStoreObjectsToArchive (ARA::PlugIn::HostArchiveWriter* archiveWriter, const ARA::PlugIn::StoreObjectsFilter* filter) noexcept override; @@ -211,8 +210,10 @@ protected: void willUpdatePlaybackRegionProperties (ARA::PlugIn::PlaybackRegion* playbackRegion, ARAPlaybackRegion::PropertiesPtr newProperties) noexcept override; void didUpdatePlaybackRegionProperties (ARA::PlugIn::PlaybackRegion* playbackRegion) noexcept override; void willDestroyPlaybackRegion (ARA::PlugIn::PlaybackRegion* playbackRegion) noexcept override; + /** @endcond */ public: + /** @cond */ //============================================================================== /** @internal */ void internalNotifyAudioSourceAnalysisProgressStarted (ARAAudioSource* audioSource) override; @@ -244,7 +245,7 @@ public: ARAContentUpdateScopes scopeFlags, bool notifyARAHost) override; -#endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h b/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h index c9758bf965..365b5e021c 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h +++ b/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h @@ -279,7 +279,7 @@ public: ~AudioProcessorValueTreeState() override; //============================================================================== - #ifndef DOXYGEN + /** @cond */ /** Previous calls to @code @@ -326,7 +326,7 @@ public: bool isDiscrete = false, AudioProcessorParameter::Category parameterCategory = AudioProcessorParameter::genericParameter, bool isBoolean = false); - #endif + /** @endcond */ /** This function adds a parameter to the attached AudioProcessor and that parameter will be managed by this AudioProcessorValueTreeState object. diff --git a/modules/juce_audio_processors/utilities/juce_ExtensionsVisitor.h b/modules/juce_audio_processors/utilities/juce_ExtensionsVisitor.h index 47641b7317..d2ea46a6ed 100644 --- a/modules/juce_audio_processors/utilities/juce_ExtensionsVisitor.h +++ b/modules/juce_audio_processors/utilities/juce_ExtensionsVisitor.h @@ -32,7 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN +/** @cond */ // Forward declarations to avoid leaking implementation details. namespace Steinberg::Vst @@ -40,7 +40,7 @@ namespace Steinberg::Vst class IComponent; } // namespace Steinberg::Vst -#endif +/** @endcond */ //============================================================================== #if TARGET_OS_IPHONE diff --git a/modules/juce_audio_processors/utilities/juce_FlagCache.h b/modules/juce_audio_processors/utilities/juce_FlagCache.h index 79af99222b..379926fd78 100644 --- a/modules/juce_audio_processors/utilities/juce_FlagCache.h +++ b/modules/juce_audio_processors/utilities/juce_FlagCache.h @@ -32,8 +32,7 @@ ============================================================================== */ -#if ! DOXYGEN - +/** @cond */ namespace juce { @@ -187,5 +186,4 @@ private: }; } // namespace juce - -#endif +/** @endcond */ diff --git a/modules/juce_audio_processors/utilities/juce_PluginHostType.h b/modules/juce_audio_processors/utilities/juce_PluginHostType.h index 0470c3e52b..b61fc6e65b 100644 --- a/modules/juce_audio_processors/utilities/juce_PluginHostType.h +++ b/modules/juce_audio_processors/utilities/juce_PluginHostType.h @@ -251,12 +251,12 @@ public: //============================================================================== - #ifndef DOXYGEN + /** @cond */ // @internal static AudioProcessor::WrapperType jucePlugInClientCurrentWrapperType; static std::function jucePlugInIsRunningInAudioSuiteFn; static String hostIdReportedByWrapper; - #endif + /** @endcond */ private: static HostType getHostType(); diff --git a/modules/juce_audio_processors/utilities/juce_VST3ClientExtensions.h b/modules/juce_audio_processors/utilities/juce_VST3ClientExtensions.h index 3e7f2d334a..2a1c846cf9 100644 --- a/modules/juce_audio_processors/utilities/juce_VST3ClientExtensions.h +++ b/modules/juce_audio_processors/utilities/juce_VST3ClientExtensions.h @@ -32,7 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN +/** @cond */ // Forward declaration to avoid leaking implementation details. namespace Steinberg @@ -41,7 +41,7 @@ namespace Steinberg using TUID = char[16]; } // namespace Steinberg -#endif // DOXYGEN +/** @endcond */ namespace juce { diff --git a/modules/juce_audio_utils/gui/juce_KeyboardComponentBase.h b/modules/juce_audio_utils/gui/juce_KeyboardComponentBase.h index de40acc9fd..fabf56e704 100644 --- a/modules/juce_audio_utils/gui/juce_KeyboardComponentBase.h +++ b/modules/juce_audio_utils/gui/juce_KeyboardComponentBase.h @@ -204,11 +204,11 @@ public: */ NoteAndVelocity getNoteAndVelocityAtPosition (Point position, bool includeChildComponents = false); - #ifndef DOXYGEN + /** @cond */ /** Returns the key at a given coordinate, or -1 if the position does not intersect a key. */ [[deprecated ("This method has been deprecated in favour of getNoteAndVelocityAtPosition.")]] int getNoteAtPosition (Point p) { return getNoteAndVelocityAtPosition (p).note; } - #endif + /** @endcond */ /** Returns the rectangle for a given key. */ Rectangle getRectangleForKey (int midiNoteNumber) const; diff --git a/modules/juce_box2d/juce_box2d.h b/modules/juce_box2d/juce_box2d.h index 3e6f5437a6..3ee9a76d47 100644 --- a/modules/juce_box2d/juce_box2d.h +++ b/modules/juce_box2d/juce_box2d.h @@ -80,6 +80,7 @@ JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE ("-Wconversion", JUCE_END_IGNORE_WARNINGS_GCC_LIKE -#ifndef DOXYGEN // for some reason, Doxygen sees this as a re-definition of Box2DRenderer - #include "utils/juce_Box2DRenderer.h" -#endif // DOXYGEN +// For some reason, Doxygen sees this as a re-definition of Box2DRenderer +/** @cond */ +#include "utils/juce_Box2DRenderer.h" +/** @endcond */ diff --git a/modules/juce_core/containers/juce_Array.h b/modules/juce_core/containers/juce_Array.h index c39622d550..ffc0234520 100644 --- a/modules/juce_core/containers/juce_Array.h +++ b/modules/juce_core/containers/juce_Array.h @@ -1107,11 +1107,11 @@ public: //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("This method has been replaced by a more flexible templated version and renamed " "to swapWith to be more consistent with the names used in other classes.")]] void swapWithArray (Array& other) noexcept { swapWith (other); } - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_core/containers/juce_ElementComparator.h b/modules/juce_core/containers/juce_ElementComparator.h index a6b649cc96..2c935e5b70 100644 --- a/modules/juce_core/containers/juce_ElementComparator.h +++ b/modules/juce_core/containers/juce_ElementComparator.h @@ -35,8 +35,7 @@ namespace juce { -#ifndef DOXYGEN - +/** @cond */ /** This is an internal helper class which converts a juce ElementComparator style class (using a "compareElements" method) into a class that's compatible with std::sort (i.e. using an operator() to compare the elements) @@ -57,8 +56,7 @@ private: SortFunctionConverter& operator= (const SortFunctionConverter&) = delete; }; - -#endif +/** @endcond */ //============================================================================== diff --git a/modules/juce_core/containers/juce_FixedSizeFunction.h b/modules/juce_core/containers/juce_FixedSizeFunction.h index 2d185ee9e5..e316f9af73 100644 --- a/modules/juce_core/containers/juce_FixedSizeFunction.h +++ b/modules/juce_core/containers/juce_FixedSizeFunction.h @@ -35,8 +35,7 @@ namespace juce { -#ifndef DOXYGEN - +/** @cond */ namespace detail { template @@ -91,8 +90,7 @@ namespace detail template class FixedSizeFunction; - -#endif +/** @endcond */ /** A type similar to `std::function` that holds a callable object. diff --git a/modules/juce_core/containers/juce_Optional.h b/modules/juce_core/containers/juce_Optional.h index a7fb632b95..4168e75668 100644 --- a/modules/juce_core/containers/juce_Optional.h +++ b/modules/juce_core/containers/juce_Optional.h @@ -42,9 +42,9 @@ constexpr auto nullopt = std::nullopt; // link time code generation. JUCE_BEGIN_IGNORE_WARNINGS_MSVC (4702) -#ifndef DOXYGEN +/** @cond */ #define JUCE_OPTIONAL_OPERATORS X(==) X(!=) X(<) X(<=) X(>) X(>=) -#endif +/** @endcond */ /** A simple optional type. @@ -175,7 +175,7 @@ Optional> makeOptional (Value&& v) return std::forward (v); } -#ifndef DOXYGEN +/** @cond */ #define X(op) \ template bool operator op (const Optional& lhs, const Optional& rhs) { return lhs.opt op rhs.opt; } \ template bool operator op (const Optional& lhs, Nullopt rhs) { return lhs.opt op rhs; } \ @@ -187,6 +187,6 @@ JUCE_OPTIONAL_OPERATORS #undef X #undef JUCE_OPTIONAL_OPERATORS -#endif +/** @endcond */ } // namespace juce diff --git a/modules/juce_core/containers/juce_OwnedArray.h b/modules/juce_core/containers/juce_OwnedArray.h index a9022ad5f4..4031bcfa5c 100644 --- a/modules/juce_core/containers/juce_OwnedArray.h +++ b/modules/juce_core/containers/juce_OwnedArray.h @@ -806,11 +806,11 @@ public: using ScopedLockType = typename TypeOfCriticalSectionToUse::ScopedLockType; //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("This method has been replaced by a more flexible templated version and renamed " "to swapWith to be more consistent with the names used in other classes.")]] void swapWithArray (OwnedArray& other) noexcept { swapWith (other); } - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_core/containers/juce_ReferenceCountedArray.h b/modules/juce_core/containers/juce_ReferenceCountedArray.h index ecf82f667e..ef7b1985e2 100644 --- a/modules/juce_core/containers/juce_ReferenceCountedArray.h +++ b/modules/juce_core/containers/juce_ReferenceCountedArray.h @@ -854,11 +854,11 @@ public: using ScopedLockType = typename TypeOfCriticalSectionToUse::ScopedLockType; //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("This method has been replaced by a more flexible templated version and renamed " "to swapWith to be more consistent with the names used in other classes.")]] void swapWithArray (ReferenceCountedArray& other) noexcept { swapWith (other); } - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_core/containers/juce_Variant.h b/modules/juce_core/containers/juce_Variant.h index 3e70efd3f6..9a853eb7c0 100644 --- a/modules/juce_core/containers/juce_Variant.h +++ b/modules/juce_core/containers/juce_Variant.h @@ -295,12 +295,14 @@ public: static var readFromStream (InputStream& input); //============================================================================== - #if JUCE_ALLOW_STATIC_NULL_VARIABLES && ! defined (DOXYGEN) + #if JUCE_ALLOW_STATIC_NULL_VARIABLES + /** @cond */ [[deprecated ("This was a static empty var object, but is now deprecated as it's too easy to accidentally " "use it indirectly during a static constructor leading to hard-to-find order-of-initialisation " "problems. Use var() or {} instead. For returning an empty var from a function by reference, " "use a function-local static var and return that.")]] static const var null; + /** @endcond */ #endif private: diff --git a/modules/juce_core/detail/juce_LruCache.h b/modules/juce_core/detail/juce_LruCache.h index 213a86ed70..7154c5606d 100644 --- a/modules/juce_core/detail/juce_LruCache.h +++ b/modules/juce_core/detail/juce_LruCache.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce { @@ -84,5 +83,4 @@ private: }; } // namespace juce - -#endif +/** @endcond */ diff --git a/modules/juce_core/files/juce_DirectoryIterator.h b/modules/juce_core/files/juce_DirectoryIterator.h index 9b05bd5abe..399177735c 100644 --- a/modules/juce_core/files/juce_DirectoryIterator.h +++ b/modules/juce_core/files/juce_DirectoryIterator.h @@ -35,8 +35,7 @@ namespace juce { -#ifndef DOXYGEN - +/** @cond */ //============================================================================== /** This class is now deprecated in favour of RangedDirectoryIterator. @@ -203,7 +202,6 @@ private: JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (DirectoryIterator) }; - -#endif +/** @endcond */ } // namespace juce diff --git a/modules/juce_core/files/juce_File.h b/modules/juce_core/files/juce_File.h index 9d4c3264a9..f59e8c25c3 100644 --- a/modules/juce_core/files/juce_File.h +++ b/modules/juce_core/files/juce_File.h @@ -35,9 +35,11 @@ namespace juce { -#if ! DOXYGEN && (JUCE_MAC || JUCE_IOS) +/** @cond */ +#if JUCE_MAC || JUCE_IOS using OSType = unsigned int; #endif +/** @endcond */ //============================================================================== /** @@ -1153,7 +1155,8 @@ public: bool foldersFirst; }; - #if JUCE_ALLOW_STATIC_NULL_VARIABLES && ! defined (DOXYGEN) + #if JUCE_ALLOW_STATIC_NULL_VARIABLES + /** @cond */ /* These static objects are deprecated because it's too easy to accidentally use them indirectly during a static constructor, which leads to very obscure order-of-initialisation bugs. Use File::getSeparatorChar() and File::getSeparatorString(), and instead of File::nonexistent, @@ -1162,6 +1165,7 @@ public: [[deprecated]] static const juce_wchar separator; [[deprecated]] static const StringRef separatorString; [[deprecated]] static const File nonexistent; + /** @endcond */ #endif private: diff --git a/modules/juce_core/json/juce_JSONSerialisation.h b/modules/juce_core/json/juce_JSONSerialisation.h index 3e2a497041..1f6109c3fc 100644 --- a/modules/juce_core/json/juce_JSONSerialisation.h +++ b/modules/juce_core/json/juce_JSONSerialisation.h @@ -499,16 +499,14 @@ struct VariantConverter } }; -#ifndef DOXYGEN - +/** @cond */ template <> struct VariantConverter { static String fromVar (const var& v) { return v.toString(); } static var toVar (const String& s) { return s; } }; - -#endif +/** @endcond */ /** A helper type that can be used to implement specialisations of VariantConverter that use diff --git a/modules/juce_core/juce_core.h b/modules/juce_core/juce_core.h index fd66714894..4f0a443dee 100644 --- a/modules/juce_core/juce_core.h +++ b/modules/juce_core/juce_core.h @@ -394,7 +394,7 @@ JUCE_END_IGNORE_WARNINGS_MSVC #include "unit_tests/juce_UnitTestCategories.h" #endif -#ifndef DOXYGEN +/** @cond */ namespace juce { /* @@ -415,7 +415,7 @@ namespace juce static this_will_fail_to_link_if_some_of_your_compile_units_are_built_in_release_mode compileUnitMismatchSentinel; #endif } -#endif +/** @endcond */ JUCE_END_IGNORE_WARNINGS_MSVC diff --git a/modules/juce_core/maths/juce_MathsFunctions.h b/modules/juce_core/maths/juce_MathsFunctions.h index 9f5484ef3c..75916abfdc 100644 --- a/modules/juce_core/maths/juce_MathsFunctions.h +++ b/modules/juce_core/maths/juce_MathsFunctions.h @@ -68,14 +68,14 @@ using uint32 = unsigned int; using uint64 = unsigned long long; #endif -#ifndef DOXYGEN - /** A macro for creating 64-bit literals. - Historically, this was needed to support portability with MSVC6, and is kept here - so that old code will still compile, but nowadays every compiler will support the - LL and ULL suffixes, so you should use those in preference to this macro. - */ - #define literal64bit(longLiteral) (longLiteral##LL) -#endif +/** @cond */ +/** A macro for creating 64-bit literals. + Historically, this was needed to support portability with MSVC6, and is kept here + so that old code will still compile, but nowadays every compiler will support the + LL and ULL suffixes, so you should use those in preference to this macro. +*/ +#define literal64bit(longLiteral) (longLiteral##LL) +/** @endcond */ #if JUCE_64BIT /** A signed integer type that's guaranteed to be large enough to hold a pointer without truncating it. */ @@ -129,7 +129,7 @@ Type juce_hypot (Type a, Type b) noexcept #endif } -#ifndef DOXYGEN +/** @cond */ template <> inline float juce_hypot (float a, float b) noexcept { @@ -139,7 +139,7 @@ inline float juce_hypot (float a, float b) noexcept return hypotf (a, b); #endif } -#endif +/** @endcond */ //============================================================================== /** Commonly used mathematical constants @@ -165,7 +165,7 @@ struct MathConstants static constexpr FloatType sqrt2 = static_cast (1.4142135623730950488L); }; -#ifndef DOXYGEN +/** @cond */ /** A double-precision constant for pi. */ [[deprecated ("This is deprecated in favour of MathConstants::pi.")]] const constexpr double double_Pi = MathConstants::pi; @@ -173,7 +173,7 @@ const constexpr double double_Pi = MathConstants::pi; /** A single-precision constant for pi. */ [[deprecated ("This is deprecated in favour of MathConstants::pi.")]] const constexpr float float_Pi = MathConstants::pi; -#endif +/** @endcond */ /** Converts an angle in degrees to radians. */ template @@ -763,7 +763,7 @@ namespace TypeHelpers */ template struct ParameterType { using type = const Type&; }; - #ifndef DOXYGEN + /** @cond */ template struct ParameterType { using type = Type&; }; template struct ParameterType { using type = Type*; }; template <> struct ParameterType { using type = char; }; @@ -779,7 +779,7 @@ namespace TypeHelpers template <> struct ParameterType { using type = bool; }; template <> struct ParameterType { using type = float; }; template <> struct ParameterType { using type = double; }; - #endif + /** @endcond */ /** These templates are designed to take a type, and if it's a double, they return a double type; for anything else, they return a float type. @@ -796,20 +796,20 @@ namespace TypeHelpers */ template struct UnsignedTypeWithSize {}; - #ifndef DOXYGEN + /** @cond */ template <> struct UnsignedTypeWithSize<1> { using type = uint8; }; template <> struct UnsignedTypeWithSize<2> { using type = uint16; }; template <> struct UnsignedTypeWithSize<4> { using type = uint32; }; template <> struct UnsignedTypeWithSize<8> { using type = uint64; }; - #endif + /** @endcond */ } //============================================================================== -#ifndef DOXYGEN - [[deprecated ("Use roundToInt instead.")]] inline int roundDoubleToInt (double value) noexcept { return roundToInt (value); } - [[deprecated ("Use roundToInt instead.")]] inline int roundFloatToInt (float value) noexcept { return roundToInt (value); } - [[deprecated ("Use std::abs() instead.")]] inline int64 abs64 (int64 n) noexcept { return std::abs (n); } -#endif +/** @cond */ +[[deprecated ("Use roundToInt instead.")]] inline int roundDoubleToInt (double value) noexcept { return roundToInt (value); } +[[deprecated ("Use roundToInt instead.")]] inline int roundFloatToInt (float value) noexcept { return roundToInt (value); } +[[deprecated ("Use std::abs() instead.")]] inline int64 abs64 (int64 n) noexcept { return std::abs (n); } +/** @endcond */ /** Converts an enum to its underlying integral type. Similar to std::to_underlying, which is only available in C++23 and above. diff --git a/modules/juce_core/memory/juce_Atomic.h b/modules/juce_core/memory/juce_Atomic.h index 0e71521c43..3d6a1d5ca2 100644 --- a/modules/juce_core/memory/juce_Atomic.h +++ b/modules/juce_core/memory/juce_Atomic.h @@ -35,13 +35,13 @@ namespace juce { -#ifndef DOXYGEN - namespace AtomicHelpers - { - template struct DiffTypeHelper { using Type = T; }; - template struct DiffTypeHelper { using Type = std::ptrdiff_t; }; - } -#endif +/** @cond */ +namespace AtomicHelpers +{ + template struct DiffTypeHelper { using Type = T; }; + template struct DiffTypeHelper { using Type = std::ptrdiff_t; }; +} +/** @endcond */ //============================================================================== /** @@ -147,11 +147,11 @@ struct Atomic final std::atomic value; //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("This method has been deprecated as there is no equivalent method in " "std::atomic. Use compareAndSetBool instead.")]] Type compareAndSetValue (Type, Type) noexcept; - #endif + /** @endcond */ }; } // namespace juce diff --git a/modules/juce_core/memory/juce_HeapBlock.h b/modules/juce_core/memory/juce_HeapBlock.h index f459fadc81..4a157178ed 100644 --- a/modules/juce_core/memory/juce_HeapBlock.h +++ b/modules/juce_core/memory/juce_HeapBlock.h @@ -35,7 +35,8 @@ namespace juce { -#if ! (DOXYGEN || JUCE_EXCEPTIONS_DISABLED) +#if ! JUCE_EXCEPTIONS_DISABLED +/** @cond */ namespace HeapBlockHelper { template @@ -44,6 +45,7 @@ namespace HeapBlockHelper template <> struct ThrowOnFail { static void checkPointer (void* data) { if (data == nullptr) throw std::bad_alloc(); } }; } +/** @endcond */ #endif //============================================================================== diff --git a/modules/juce_core/memory/juce_Memory.h b/modules/juce_core/memory/juce_Memory.h index 894d07ec66..42d5cb42b0 100644 --- a/modules/juce_core/memory/juce_Memory.h +++ b/modules/juce_core/memory/juce_Memory.h @@ -178,7 +178,8 @@ inline const Type* addBytesToPointer (const Type* basePointer, IntegerType bytes avoiding problems when an object is created in one module and passed across to another where it is deleted. By piggy-backing on the JUCE_LEAK_DETECTOR macro, these allocators can be injected into most juce classes. */ -#if JUCE_MSVC && (defined (JUCE_DLL) || defined (JUCE_DLL_BUILD)) && ! (JUCE_DISABLE_DLL_ALLOCATORS || DOXYGEN) +#if JUCE_MSVC && (defined (JUCE_DLL) || defined (JUCE_DLL_BUILD)) && ! JUCE_DISABLE_DLL_ALLOCATORS + /** @cond */ extern JUCE_API void* juceDLL_malloc (size_t); extern JUCE_API void juceDLL_free (void*); @@ -187,6 +188,7 @@ inline const Type* addBytesToPointer (const Type* basePointer, IntegerType bytes static void* operator new (size_t, void* p) { return p; } \ static void operator delete (void* p) { juce::juceDLL_free (p); } \ static void operator delete (void*, void*) {} + /** @endcond */ #endif //============================================================================== diff --git a/modules/juce_core/memory/juce_MemoryBlock.h b/modules/juce_core/memory/juce_MemoryBlock.h index 29eaf014d8..2ea4ebf53f 100644 --- a/modules/juce_core/memory/juce_MemoryBlock.h +++ b/modules/juce_core/memory/juce_MemoryBlock.h @@ -281,14 +281,14 @@ public: bool fromBase64Encoding (StringRef encodedString); //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("Use the replaceAll method instead, which will also replace the data when numBytes == 0.")]] void replaceWith (const void* srcData, size_t numBytes) { if (numBytes > 0) replaceAll (srcData, numBytes); } - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_core/memory/juce_ReferenceCountedObject.h b/modules/juce_core/memory/juce_ReferenceCountedObject.h index 079ae9a3ab..1c31662577 100644 --- a/modules/juce_core/memory/juce_ReferenceCountedObject.h +++ b/modules/juce_core/memory/juce_ReferenceCountedObject.h @@ -440,10 +440,10 @@ public: operator ReferencedType*() const noexcept { return referencedObject; } #endif - #ifndef DOXYGEN + /** @cond */ [[deprecated ("Use the get method instead.")]] ReferencedType* getObject() const { return get(); } - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_core/memory/juce_ScopedPointer.h b/modules/juce_core/memory/juce_ScopedPointer.h index 107190bff1..31c9c1d4bf 100644 --- a/modules/juce_core/memory/juce_ScopedPointer.h +++ b/modules/juce_core/memory/juce_ScopedPointer.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce { @@ -228,5 +227,4 @@ void deleteAndZero (ScopedPointer&) { static_assert (sizeof (Type) == 123 JUCE_END_IGNORE_DEPRECATION_WARNINGS } // namespace juce - -#endif +/** @endcond */ diff --git a/modules/juce_core/memory/juce_SharedResourcePointer.h b/modules/juce_core/memory/juce_SharedResourcePointer.h index 78b514bae2..d80fa29bdc 100644 --- a/modules/juce_core/memory/juce_SharedResourcePointer.h +++ b/modules/juce_core/memory/juce_SharedResourcePointer.h @@ -128,10 +128,10 @@ public: /** Returns a reference to the shared object. */ SharedObjectType& operator*() const noexcept { return *sharedObject; } - #ifndef DOXYGEN + /** @cond */ [[deprecated ("If you are relying on this function please inform the JUCE team as we are planing on removing this in a subsequent release")]] int getReferenceCount() const noexcept { return (int) sharedObject.use_count(); } - #endif + /** @endcond */ /** Returns the SharedResourcePointer if one already exists, or a null optional otherwise. */ static std::optional getSharedObjectWithoutCreating() diff --git a/modules/juce_core/memory/juce_Singleton.h b/modules/juce_core/memory/juce_Singleton.h index 5c472c5137..70db5c4876 100644 --- a/modules/juce_core/memory/juce_Singleton.h +++ b/modules/juce_core/memory/juce_Singleton.h @@ -135,7 +135,7 @@ struct SingletonHolder : private MutexType // (inherited so we can use the empt std::atomic instance { nullptr }; }; -#ifndef DOXYGEN +/** @cond */ #define JUCE_PRIVATE_DECLARE_SINGLETON(Classname, mutex, doNotRecreate, inlineToken, getter) \ static inlineToken juce::SingletonHolder singletonHolder; \ friend juce::SingletonHolder; \ @@ -143,7 +143,7 @@ struct SingletonHolder : private MutexType // (inherited so we can use the empt static Classname* JUCE_CALLTYPE getInstanceWithoutCreating() noexcept { return singletonHolder.instance; } \ static void JUCE_CALLTYPE deleteInstance() noexcept { singletonHolder.deleteInstance(); } \ void clearSingletonInstance() noexcept { singletonHolder.clear (this); } -#endif +/** @endcond */ //============================================================================== /** @@ -281,14 +281,14 @@ struct SingletonHolder : private MutexType // (inherited so we can use the empt JUCE_PRIVATE_DECLARE_SINGLETON (Classname, juce::DummyCriticalSection, false, inline, getWithoutChecking) //============================================================================== -#ifndef DOXYGEN - // These are ancient macros, and have now been updated with new names to match the JUCE style guide, - // so please update your code to use the newer versions! - #define juce_DeclareSingleton(Classname, doNotRecreate) JUCE_DECLARE_SINGLETON(Classname, doNotRecreate) - #define juce_DeclareSingleton_SingleThreaded(Classname, doNotRecreate) JUCE_DECLARE_SINGLETON_SINGLETHREADED(Classname, doNotRecreate) - #define juce_DeclareSingleton_SingleThreaded_Minimal(Classname) JUCE_DECLARE_SINGLETON_SINGLETHREADED_MINIMAL(Classname) - #define juce_ImplementSingleton(Classname) JUCE_IMPLEMENT_SINGLETON(Classname) - #define juce_ImplementSingleton_SingleThreaded(Classname) JUCE_IMPLEMENT_SINGLETON(Classname) -#endif +/** @cond */ +// These are ancient macros, and have now been updated with new names to match the JUCE style guide, +// so please update your code to use the newer versions! +#define juce_DeclareSingleton(Classname, doNotRecreate) JUCE_DECLARE_SINGLETON(Classname, doNotRecreate) +#define juce_DeclareSingleton_SingleThreaded(Classname, doNotRecreate) JUCE_DECLARE_SINGLETON_SINGLETHREADED(Classname, doNotRecreate) +#define juce_DeclareSingleton_SingleThreaded_Minimal(Classname) JUCE_DECLARE_SINGLETON_SINGLETHREADED_MINIMAL(Classname) +#define juce_ImplementSingleton(Classname) JUCE_IMPLEMENT_SINGLETON(Classname) +#define juce_ImplementSingleton_SingleThreaded(Classname) JUCE_IMPLEMENT_SINGLETON(Classname) +/** @endcond */ } // namespace juce diff --git a/modules/juce_core/misc/juce_Functional.h b/modules/juce_core/misc/juce_Functional.h index 4accad5368..b33a61e4b4 100644 --- a/modules/juce_core/misc/juce_Functional.h +++ b/modules/juce_core/misc/juce_Functional.h @@ -35,7 +35,7 @@ namespace juce { -#ifndef DOXYGEN +/** @cond */ namespace detail { template @@ -47,7 +47,7 @@ namespace detail template constexpr auto equalityComparableToNullptr() != nullptr)>> = true; } // namespace detail -#endif +/** @endcond */ //============================================================================== /** Some helper methods for checking a callable object before invoking with @@ -98,7 +98,7 @@ template @@ -107,7 +107,7 @@ static constexpr auto toFnPtr (Functor functor, Return (Functor::*) (Args...) co return static_cast (functor); } } // namespace detail -#endif +/** @endcond */ /** Converts a captureless lambda to its equivalent function pointer type. */ template diff --git a/modules/juce_core/misc/juce_Uuid.h b/modules/juce_core/misc/juce_Uuid.h index 37d1e51588..98e61cc651 100644 --- a/modules/juce_core/misc/juce_Uuid.h +++ b/modules/juce_core/misc/juce_Uuid.h @@ -151,7 +151,7 @@ private: } // namespace juce -#ifndef DOXYGEN +/** @cond */ namespace std { template <> struct hash @@ -159,4 +159,4 @@ namespace std size_t operator() (const juce::Uuid& u) const noexcept { return (size_t) u.hash(); } }; } -#endif +/** @endcond */ diff --git a/modules/juce_core/misc/juce_WindowsRegistry.h b/modules/juce_core/misc/juce_WindowsRegistry.h index 59f5b02607..d950f055b4 100644 --- a/modules/juce_core/misc/juce_WindowsRegistry.h +++ b/modules/juce_core/misc/juce_WindowsRegistry.h @@ -135,12 +135,12 @@ public: bool registerForCurrentUserOnly, WoW64Mode mode = WoW64_Default); - #ifndef DOXYGEN + /** @cond */ // DEPRECATED: use the other methods with a WoW64Mode parameter of WoW64_64bit instead. [[deprecated]] static String getValueWow64 (const String&, const String& defaultValue = String()); [[deprecated]] static bool valueExistsWow64 (const String&); [[deprecated]] static bool keyExistsWow64 (const String&); - #endif + /** @endcond */ private: WindowsRegistry() = delete; diff --git a/modules/juce_core/native/juce_ObjCHelpers_mac.h b/modules/juce_core/native/juce_ObjCHelpers_mac.h index ce2d0600ed..0c1450e8c3 100644 --- a/modules/juce_core/native/juce_ObjCHelpers_mac.h +++ b/modules/juce_core/native/juce_ObjCHelpers_mac.h @@ -382,7 +382,7 @@ private: }; //============================================================================== -#ifndef DOXYGEN +/** @cond */ template struct ObjCLifetimeManagedClass : public ObjCClass { @@ -424,7 +424,7 @@ struct ObjCLifetimeManagedClass : public ObjCClass template ObjCLifetimeManagedClass ObjCLifetimeManagedClass::objCLifetimeManagedClass; -#endif +/** @endcond */ // this will return an NSObject which takes ownership of the JUCE instance passed-in // This is useful to tie the life-time of a juce instance to the life-time of an NSObject diff --git a/modules/juce_core/network/juce_URL.h b/modules/juce_core/network/juce_URL.h index 421a054a28..746d393adf 100644 --- a/modules/juce_core/network/juce_URL.h +++ b/modules/juce_core/network/juce_URL.h @@ -684,7 +684,7 @@ public: static URL createWithoutParsing (const String& url); //============================================================================== - #ifndef DOXYGEN + /** @cond */ using OpenStreamProgressCallback = bool (void* context, int bytesSent, int totalBytes); /** This method has been deprecated. @@ -701,7 +701,7 @@ public: int* statusCode = nullptr, int numRedirectsToFollow = 5, String httpRequestCmd = {}) const; - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_core/serialisation/juce_Serialisation.h b/modules/juce_core/serialisation/juce_Serialisation.h index be6912260f..e11e7409bf 100644 --- a/modules/juce_core/serialisation/juce_Serialisation.h +++ b/modules/juce_core/serialisation/juce_Serialisation.h @@ -148,8 +148,7 @@ template constexpr auto serialisationSize (const T& t) -> std::enab The following are specialisations of SerialisationTraits for commonly-used types. */ -#ifndef DOXYGEN - +/** @cond */ template struct SerialisationTraits> { @@ -583,6 +582,6 @@ namespace detail } } // namespace detail -#endif +/** @endcond */ } // namespace juce diff --git a/modules/juce_core/system/juce_CompilerSupport.h b/modules/juce_core/system/juce_CompilerSupport.h index 6a8acdf0b3..6a08fab27b 100644 --- a/modules/juce_core/system/juce_CompilerSupport.h +++ b/modules/juce_core/system/juce_CompilerSupport.h @@ -113,14 +113,14 @@ #endif //============================================================================== -#ifndef DOXYGEN - // These are old flags that are now supported on all compatible build targets - #define JUCE_CXX14_IS_AVAILABLE 1 - #define JUCE_COMPILER_SUPPORTS_OVERRIDE_AND_FINAL 1 - #define JUCE_COMPILER_SUPPORTS_VARIADIC_TEMPLATES 1 - #define JUCE_COMPILER_SUPPORTS_INITIALIZER_LISTS 1 - #define JUCE_COMPILER_SUPPORTS_NOEXCEPT 1 - #define JUCE_DELETED_FUNCTION = delete - #define JUCE_CONSTEXPR constexpr - #define JUCE_NODISCARD [[nodiscard]] -#endif +// These are old flags that are now supported on all compatible build targets +/** @cond */ +#define JUCE_CXX14_IS_AVAILABLE 1 +#define JUCE_COMPILER_SUPPORTS_OVERRIDE_AND_FINAL 1 +#define JUCE_COMPILER_SUPPORTS_VARIADIC_TEMPLATES 1 +#define JUCE_COMPILER_SUPPORTS_INITIALIZER_LISTS 1 +#define JUCE_COMPILER_SUPPORTS_NOEXCEPT 1 +#define JUCE_DELETED_FUNCTION = delete +#define JUCE_CONSTEXPR constexpr +#define JUCE_NODISCARD [[nodiscard]] +/** @endcond */ diff --git a/modules/juce_core/system/juce_CompilerWarnings.h b/modules/juce_core/system/juce_CompilerWarnings.h index 5777086d99..8d758a34c4 100644 --- a/modules/juce_core/system/juce_CompilerWarnings.h +++ b/modules/juce_core/system/juce_CompilerWarnings.h @@ -36,7 +36,7 @@ #include "juce_TargetPlatform.h" -// @cond +/** @cond */ /** Return the Nth argument. By passing a variadic pack followed by N other parameters, we can select one of those N parameter based on the length of the parameter pack. @@ -161,7 +161,7 @@ /** Quote the argument, turning it into a string. */ #define JUCE_TO_STRING(x) #x -// @endcond +/** @endcond */ #if JUCE_CLANG || JUCE_GCC #define JUCE_IGNORE_GCC_IMPL_(compiler, warning) #define JUCE_IGNORE_GCC_IMPL_0(compiler, warning) diff --git a/modules/juce_core/system/juce_PlatformDefs.h b/modules/juce_core/system/juce_PlatformDefs.h index cdc27c55f8..47cdf01046 100644 --- a/modules/juce_core/system/juce_PlatformDefs.h +++ b/modules/juce_core/system/juce_PlatformDefs.h @@ -129,12 +129,14 @@ namespace juce #endif //============================================================================== -#if JUCE_MSVC && ! defined (DOXYGEN) +#if JUCE_MSVC + /** @cond */ #define JUCE_BLOCK_WITH_FORCED_SEMICOLON(x) \ __pragma(warning(push)) \ __pragma(warning(disable:4127)) \ do { x } while (false) \ __pragma(warning(pop)) + /** @endcond */ #else /** This is the good old C++ trick for creating a macro that forces the user to put a semicolon after it when they use it. @@ -204,10 +206,10 @@ namespace juce #define JUCE_ASSERTIONS_ENABLED_OR_LOGGED JUCE_ASSERTIONS_ENABLED || JUCE_LOG_ASSERTIONS //============================================================================== -#ifndef DOXYGEN - #define JUCE_JOIN_MACRO_HELPER(a, b) a ## b - #define JUCE_STRINGIFY_MACRO_HELPER(a) #a -#endif +/** @cond */ +#define JUCE_JOIN_MACRO_HELPER(a, b) a ## b +#define JUCE_STRINGIFY_MACRO_HELPER(a) #a +/** @endcond */ /** A good old-fashioned C macro concatenation helper. This combines two items (which may themselves be macros) into a single string, @@ -271,8 +273,10 @@ namespace juce static void operator delete (void*) = delete; //============================================================================== -#if JUCE_MSVC && ! defined (DOXYGEN) +#if JUCE_MSVC + /** @cond */ #define JUCE_COMPILER_WARNING(msg) __pragma (message (__FILE__ "(" JUCE_STRINGIFY (__LINE__) ") : Warning: " msg)) + /** @endcond */ #else /** This macro allows you to emit a custom compiler warning message. @@ -314,8 +318,10 @@ namespace juce #endif //============================================================================== -#if JUCE_ANDROID && ! defined (DOXYGEN) +#if JUCE_ANDROID + /** @cond */ #define JUCE_MODAL_LOOPS_PERMITTED 0 + /** @endcond */ #elif ! defined (JUCE_MODAL_LOOPS_PERMITTED) /** Some operating environments don't provide a modal loop mechanism, so this flag can be used to disable any functions that try to run a modal loop. */ @@ -323,11 +329,13 @@ namespace juce #endif //============================================================================== +/** @cond */ #if JUCE_GCC || JUCE_CLANG #define JUCE_PACKED __attribute__ ((packed)) -#elif ! defined (DOXYGEN) +#else #define JUCE_PACKED #endif +/** @endcond */ //============================================================================== #if JUCE_GCC || DOXYGEN diff --git a/modules/juce_core/system/juce_StandardHeader.h b/modules/juce_core/system/juce_StandardHeader.h index 9cd78c0005..a3dc2228be 100644 --- a/modules/juce_core/system/juce_StandardHeader.h +++ b/modules/juce_core/system/juce_StandardHeader.h @@ -53,10 +53,10 @@ */ #define JUCE_VERSION ((JUCE_MAJOR_VERSION << 16) + (JUCE_MINOR_VERSION << 8) + JUCE_BUILDNUMBER) -#if ! DOXYGEN +/** @cond */ #define JUCE_VERSION_ID \ [[maybe_unused]] volatile auto juceVersionId = "juce_version_" JUCE_STRINGIFY(JUCE_MAJOR_VERSION) "_" JUCE_STRINGIFY(JUCE_MINOR_VERSION) "_" JUCE_STRINGIFY(JUCE_BUILDNUMBER); -#endif +/** @endcond */ //============================================================================== #include @@ -173,6 +173,6 @@ JUCE_END_IGNORE_WARNINGS_MSVC /** This macro is added to all JUCE public function declarations. */ #define JUCE_PUBLIC_FUNCTION JUCE_API JUCE_CALLTYPE -#ifndef DOXYGEN - #define JUCE_NAMESPACE juce // This old macro is deprecated: you should just use the juce namespace directly. -#endif +/** @cond */ +#define JUCE_NAMESPACE juce // This old macro is deprecated: you should just use the juce namespace directly. +/** @endcond */ diff --git a/modules/juce_core/system/juce_SystemStats.h b/modules/juce_core/system/juce_SystemStats.h index 31d1aa410f..ac7f2ca9b0 100644 --- a/modules/juce_core/system/juce_SystemStats.h +++ b/modules/juce_core/system/juce_SystemStats.h @@ -294,10 +294,10 @@ public: #endif //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("This method was spelt wrong! Please change your code to use getCpuSpeedInMegahertz instead.")]] static int getCpuSpeedInMegaherz() { return getCpuSpeedInMegahertz(); } - #endif + /** @endcond */ private: SystemStats() = delete; // uses only static methods diff --git a/modules/juce_core/text/juce_CharPointer_UTF16.h b/modules/juce_core/text/juce_CharPointer_UTF16.h index 7a0f82243d..dd5c49d39f 100644 --- a/modules/juce_core/text/juce_CharPointer_UTF16.h +++ b/modules/juce_core/text/juce_CharPointer_UTF16.h @@ -350,7 +350,8 @@ public: return CharacterFunctions::compareIgnoreCaseUpTo (*this, other, maxChars); } - #if JUCE_MSVC && ! defined (DOXYGEN) + #if JUCE_MSVC + /** @cond */ int compareIgnoreCase (CharPointer_UTF16 other) const noexcept { return _wcsicmp (data, other.data); @@ -366,6 +367,7 @@ public: const CharType* const t = wcsstr (data, stringToFind.getAddress()); return t == nullptr ? -1 : (int) (t - data); } + /** @endcond */ #endif /** Returns the character index of a substring, or -1 if it isn't found. */ diff --git a/modules/juce_core/text/juce_CharacterFunctions.h b/modules/juce_core/text/juce_CharacterFunctions.h index 4487b09b09..7a1edcd456 100644 --- a/modules/juce_core/text/juce_CharacterFunctions.h +++ b/modules/juce_core/text/juce_CharacterFunctions.h @@ -36,10 +36,12 @@ namespace juce { //============================================================================== -#if JUCE_WINDOWS && ! defined (DOXYGEN) +#if JUCE_WINDOWS + /** @cond */ #define JUCE_NATIVE_WCHAR_IS_UTF8 0 #define JUCE_NATIVE_WCHAR_IS_UTF16 1 #define JUCE_NATIVE_WCHAR_IS_UTF32 0 + /** @endcond */ #else /** This macro will be set to 1 if the compiler's native wchar_t is an 8-bit type. */ #define JUCE_NATIVE_WCHAR_IS_UTF8 0 @@ -56,10 +58,10 @@ namespace juce using juce_wchar = uint32; #endif -#ifndef DOXYGEN - /** This macro is deprecated, but preserved for compatibility with old code. */ - #define JUCE_T(stringLiteral) (L##stringLiteral) -#endif +// This macro is deprecated, but preserved for compatibility with old code. +/** @cond */ +#define JUCE_T(stringLiteral) (L##stringLiteral) +/** @endcond */ #if JUCE_DEFINE_T_MACRO /** The 'T' macro is an alternative for using the "L" prefix in front of a string literal. @@ -72,8 +74,7 @@ namespace juce #define T(stringLiteral) JUCE_T(stringLiteral) #endif -#ifndef DOXYGEN - +/** @cond */ //============================================================================== // GNU libstdc++ does not have std::make_unsigned namespace internal @@ -86,8 +87,7 @@ namespace internal template <> struct make_unsigned { using type = unsigned long; }; template <> struct make_unsigned { using type = unsigned long long; }; } - -#endif +/** @endcond */ //============================================================================== /** diff --git a/modules/juce_core/text/juce_String.h b/modules/juce_core/text/juce_String.h index 761e3de9ef..25afe617fc 100644 --- a/modules/juce_core/text/juce_String.h +++ b/modules/juce_core/text/juce_String.h @@ -32,7 +32,8 @@ ============================================================================== */ -#if ! defined (DOXYGEN) && (JUCE_MAC || JUCE_IOS) +#if JUCE_MAC || JUCE_IOS + /** @cond */ // Annoyingly we can only forward-declare a typedef by forward-declaring the // aliased type #if __has_attribute(objc_bridge) @@ -44,6 +45,7 @@ typedef const struct JUCE_CF_BRIDGED_TYPE(NSString) __CFString * CFStringRef; #undef JUCE_CF_BRIDGED_TYPE + /** @endcond */ #endif namespace juce @@ -1051,11 +1053,11 @@ public: */ String (double doubleValue, int numberOfDecimalPlaces, bool useScientificNotation = false); - #ifndef DOXYGEN + /** @cond */ // Automatically creating a String from a bool opens up lots of nasty type conversion edge cases. // If you want a String representation of a bool you can cast the bool to an int first. explicit String (bool) = delete; - #endif + /** @endcond */ /** Reads the value of the string as a decimal number (up to 32 bits in size). @@ -1360,12 +1362,14 @@ public: int getReferenceCount() const noexcept; //============================================================================== - #if JUCE_ALLOW_STATIC_NULL_VARIABLES && ! defined (DOXYGEN) + #if JUCE_ALLOW_STATIC_NULL_VARIABLES + /** @cond */ [[deprecated ("This was a static empty string object, but is now deprecated as it's too easy to accidentally " "use it indirectly during a static constructor, leading to hard-to-find order-of-initialisation " "problems. If you need an empty String object, just use String() or {}. For returning an empty " "String from a function by reference, use a function-local static String object and return that.")]] static const String empty; + /** @endcond */ #endif private: @@ -1470,11 +1474,11 @@ JUCE_API String& JUCE_CALLTYPE operator<< (String& string1, float number); /** Appends a decimal number to the end of a string. */ JUCE_API String& JUCE_CALLTYPE operator<< (String& string1, double number); -#ifndef DOXYGEN +/** @cond */ // Automatically creating a String from a bool opens up lots of nasty type conversion edge cases. // If you want a String representation of a bool you can cast the bool to an int first. String& JUCE_CALLTYPE operator<< (String&, bool) = delete; -#endif +/** @endcond */ //============================================================================== /** Case-sensitive comparison of two strings. */ @@ -1530,7 +1534,7 @@ JUCE_API OutputStream& JUCE_CALLTYPE operator<< (OutputStream& stream, StringRef } // namespace juce -#ifndef DOXYGEN +/** @cond */ namespace std { template <> struct hash @@ -1538,4 +1542,4 @@ namespace std size_t operator() (const juce::String& s) const noexcept { return s.hash(); } }; } -#endif +/** @endcond */ diff --git a/modules/juce_core/text/juce_StringRef.h b/modules/juce_core/text/juce_StringRef.h index 16ce3f724d..a254d845a3 100644 --- a/modules/juce_core/text/juce_StringRef.h +++ b/modules/juce_core/text/juce_StringRef.h @@ -141,10 +141,12 @@ public: /** The text that is referenced. */ String::CharPointerType text; - #if JUCE_STRING_UTF_TYPE != 8 && ! defined (DOXYGEN) + #if JUCE_STRING_UTF_TYPE != 8 + /** @cond */ // Sorry, non-UTF8 people, you're unable to take advantage of StringRef, because // you've chosen a character encoding that doesn't match C++ string literals. String stringCopy; + /** @endcond */ #endif }; diff --git a/modules/juce_core/threads/juce_Thread.h b/modules/juce_core/threads/juce_Thread.h index a61d7b22e3..71baab4d82 100644 --- a/modules/juce_core/threads/juce_Thread.h +++ b/modules/juce_core/threads/juce_Thread.h @@ -608,9 +608,9 @@ private: std::atomic priority; #endif - #ifndef DOXYGEN + /** @cond */ friend void JUCE_API juce_threadEntryPoint (void*); - #endif + /** @endcond */ bool startThreadInternal (Priority); bool createNativeThread (Priority); diff --git a/modules/juce_core/threads/juce_TimeSliceThread.h b/modules/juce_core/threads/juce_TimeSliceThread.h index 0130a92332..c39a2aa705 100644 --- a/modules/juce_core/threads/juce_TimeSliceThread.h +++ b/modules/juce_core/threads/juce_TimeSliceThread.h @@ -147,9 +147,9 @@ public: bool contains (const TimeSliceClient*) const; //============================================================================== - #ifndef DOXYGEN + /** @cond */ void run() override; - #endif + /** @endcond */ //============================================================================== private: diff --git a/modules/juce_core/xml/juce_XmlElement.h b/modules/juce_core/xml/juce_XmlElement.h index 1805b47cba..d0d6427bf1 100644 --- a/modules/juce_core/xml/juce_XmlElement.h +++ b/modules/juce_core/xml/juce_XmlElement.h @@ -874,7 +874,7 @@ public: return AttributeIterator { attributes.get() }; } - #ifndef DOXYGEN + /** @cond */ [[deprecated]] void macroBasedForLoop() const noexcept {} [[deprecated ("This has been deprecated in favour of the toString method.")]] @@ -897,7 +897,7 @@ public: StringRef dtdToUse, StringRef encodingType = "UTF-8", int lineWrapLength = 60) const; - #endif + /** @endcond */ private: //============================================================================== @@ -926,7 +926,7 @@ private: }; //============================================================================== -#ifndef DOXYGEN +/** @cond */ /** DEPRECATED: A handy macro to make it easy to iterate all the child elements in an XmlElement. @@ -979,6 +979,6 @@ private: #define forEachXmlChildElementWithTagName(parentXmlElement, childElementVariableName, requiredTagName) \ for (auto* (childElementVariableName) : ((parentXmlElement).macroBasedForLoop(), (parentXmlElement).getChildWithTagNameIterator ((requiredTagName)))) -#endif +/** @endcond */ } // namespace juce diff --git a/modules/juce_data_structures/values/juce_ValueTree.h b/modules/juce_data_structures/values/juce_ValueTree.h index 87d0368993..f2da0c413d 100644 --- a/modules/juce_data_structures/values/juce_ValueTree.h +++ b/modules/juce_data_structures/values/juce_ValueTree.h @@ -617,10 +617,12 @@ public: */ int getReferenceCount() const noexcept; - #if JUCE_ALLOW_STATIC_NULL_VARIABLES && ! defined (DOXYGEN) + #if JUCE_ALLOW_STATIC_NULL_VARIABLES + /** @cond */ /* An invalid ValueTree that can be used if you need to return one as an error condition, etc. */ [[deprecated ("If you need an empty ValueTree object, just use ValueTree() or {}.")]] static const ValueTree invalid; + /** @endcond */ #endif private: diff --git a/modules/juce_data_structures/values/juce_ValueTreePropertyWithDefault.h b/modules/juce_data_structures/values/juce_ValueTreePropertyWithDefault.h index 389df86a9f..035492a663 100644 --- a/modules/juce_data_structures/values/juce_ValueTreePropertyWithDefault.h +++ b/modules/juce_data_structures/values/juce_ValueTreePropertyWithDefault.h @@ -335,11 +335,11 @@ private: }; //============================================================================== -#ifndef DOXYGEN +/** @cond */ using ValueWithDefault [[deprecated ("This class has been renamed to better describe what is does. " "This declaration is here for backwards compatibility and new " "code should use the new class name.")]] = ValueTreePropertyWithDefault; -#endif +/** @endcond */ } // namespace juce diff --git a/modules/juce_dsp/containers/juce_AudioBlock.h b/modules/juce_dsp/containers/juce_AudioBlock.h index dc42aeaed3..6eea893eac 100644 --- a/modules/juce_dsp/containers/juce_AudioBlock.h +++ b/modules/juce_dsp/containers/juce_AudioBlock.h @@ -35,7 +35,7 @@ namespace juce::dsp { -#ifndef DOXYGEN +/** @cond */ namespace SampleTypeHelpers // Internal classes needed for handling sample type classes { template > @@ -56,7 +56,7 @@ namespace SampleTypeHelpers // Internal classes needed for handling sample type using Type = typename T::value_type; }; } -#endif +/** @endcond */ //============================================================================== /** diff --git a/modules/juce_dsp/containers/juce_SIMDRegister.h b/modules/juce_dsp/containers/juce_SIMDRegister.h index 03160e50b6..1eabdf25b2 100644 --- a/modules/juce_dsp/containers/juce_SIMDRegister.h +++ b/modules/juce_dsp/containers/juce_SIMDRegister.h @@ -35,11 +35,11 @@ namespace juce::dsp { -#ifndef DOXYGEN - // This class is needed internally. - template - struct CmplxSIMDOps; -#endif +/** @cond */ +// This class is needed internally. +template +struct CmplxSIMDOps; +/** @endcond */ //============================================================================== /** diff --git a/modules/juce_dsp/containers/juce_SIMDRegister_Impl.h b/modules/juce_dsp/containers/juce_SIMDRegister_Impl.h index 70195be2a0..f14608dff3 100644 --- a/modules/juce_dsp/containers/juce_SIMDRegister_Impl.h +++ b/modules/juce_dsp/containers/juce_SIMDRegister_Impl.h @@ -54,7 +54,7 @@ private: size_t idx; }; -#ifndef DOXYGEN +/** @cond */ //============================================================================== /* This class is used internally by SIMDRegister to abstract away differences in operations which are different for complex and pure floating point types. */ @@ -167,7 +167,7 @@ struct CmplxSIMDOps> return SIMDNativeOps::add (a, SIMDNativeOps::cmplxmul (b, c)); } }; -#endif +/** @endcond */ //============================================================================== namespace util diff --git a/modules/juce_dsp/frequency/juce_FFT.h b/modules/juce_dsp/frequency/juce_FFT.h index 9280c0c785..3987d6a9fd 100644 --- a/modules/juce_dsp/frequency/juce_FFT.h +++ b/modules/juce_dsp/frequency/juce_FFT.h @@ -118,11 +118,11 @@ public: int getSize() const noexcept { return size; } //============================================================================== - #ifndef DOXYGEN - /* internal */ + /** @internal */ + /** @cond */ struct Instance; template struct EngineImpl; - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_dsp/juce_dsp.h b/modules/juce_dsp/juce_dsp.h index a76bc37189..aefc25ae9d 100644 --- a/modules/juce_dsp/juce_dsp.h +++ b/modules/juce_dsp/juce_dsp.h @@ -217,19 +217,19 @@ namespace util /** Use this function to prevent denormals on intel CPUs. This function will work with both primitives and simple containers. */ - #if JUCE_DSP_ENABLE_SNAP_TO_ZERO + #if JUCE_DSP_ENABLE_SNAP_TO_ZERO inline void snapToZero (float& x) noexcept { JUCE_SNAP_TO_ZERO (x); } - #ifndef DOXYGEN + /** @cond */ inline void snapToZero (double& x) noexcept { JUCE_SNAP_TO_ZERO (x); } inline void snapToZero (long double& x) noexcept { JUCE_SNAP_TO_ZERO (x); } - #endif - #else + /** @endcond */ + #else inline void snapToZero ([[maybe_unused]] float& x) noexcept {} - #ifndef DOXYGEN + /** @cond */ inline void snapToZero ([[maybe_unused]] double& x) noexcept {} inline void snapToZero ([[maybe_unused]] long double& x) noexcept {} + /** @endcond */ #endif - #endif } } diff --git a/modules/juce_dsp/native/juce_SIMDNativeOps_avx.h b/modules/juce_dsp/native/juce_SIMDNativeOps_avx.h index 9489a6a1c5..3d5f8cb302 100644 --- a/modules/juce_dsp/native/juce_SIMDNativeOps_avx.h +++ b/modules/juce_dsp/native/juce_SIMDNativeOps_avx.h @@ -32,11 +32,10 @@ ============================================================================== */ +/** @cond */ namespace juce::dsp { -#ifndef DOXYGEN - JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE ("-Wignored-attributes") #ifdef _MSC_VER @@ -660,8 +659,7 @@ struct SIMDNativeOps static forcedinline __m256i JUCE_VECTOR_CALLTYPE truncate (__m256i a) noexcept { return a; } }; -#endif - JUCE_END_IGNORE_WARNINGS_GCC_LIKE } // namespace juce::dsp +/** @endcond */ diff --git a/modules/juce_dsp/native/juce_SIMDNativeOps_neon.h b/modules/juce_dsp/native/juce_SIMDNativeOps_neon.h index 26fbc4deb8..1cd9e73876 100644 --- a/modules/juce_dsp/native/juce_SIMDNativeOps_neon.h +++ b/modules/juce_dsp/native/juce_SIMDNativeOps_neon.h @@ -32,11 +32,10 @@ ============================================================================== */ +/** @cond */ namespace juce::dsp { -#ifndef DOXYGEN - JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE ("-Wignored-attributes") #ifdef _MSC_VER @@ -53,7 +52,7 @@ JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE ("-Wignored-attributes") #define DEFINE_NEON_SIMD_CONST(type, class_type, name) \ const type SIMDNativeOps:: name [16 / sizeof (type)] __attribute__ ((aligned (16))) -#endif +#endif // _MSC_VER template struct SIMDNativeOps; @@ -541,8 +540,8 @@ struct SIMDNativeOps static forcedinline vSIMDType truncate (vSIMDType a) noexcept { return fb::truncate (a); } }; #endif // JUCE_64BIT -#endif // #ifndef DOXYGEN JUCE_END_IGNORE_WARNINGS_GCC_LIKE } // namespace juce::dsp +/** @endcond */ diff --git a/modules/juce_dsp/native/juce_SIMDNativeOps_sse.h b/modules/juce_dsp/native/juce_SIMDNativeOps_sse.h index faa2c46666..03fc816441 100644 --- a/modules/juce_dsp/native/juce_SIMDNativeOps_sse.h +++ b/modules/juce_dsp/native/juce_SIMDNativeOps_sse.h @@ -32,11 +32,10 @@ ============================================================================== */ +/** @cond */ namespace juce::dsp { -#ifndef DOXYGEN - JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE ("-Wignored-attributes") #ifdef _MSC_VER @@ -53,7 +52,7 @@ JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE ("-Wignored-attributes") #define DEFINE_SSE_SIMD_CONST(type, class_type, name) \ const type SIMDNativeOps:: name [16 / sizeof (type)] __attribute__ ((aligned (16))) -#endif +#endif // _MSC_VER template struct SIMDNativeOps; @@ -730,8 +729,7 @@ struct SIMDNativeOps } }; -#endif - JUCE_END_IGNORE_WARNINGS_GCC_LIKE } // namespace juce::dsp +/** @endcond */ diff --git a/modules/juce_dsp/processors/juce_IIRFilter_Impl.h b/modules/juce_dsp/processors/juce_IIRFilter_Impl.h index f7cadf792e..3ea4547775 100644 --- a/modules/juce_dsp/processors/juce_IIRFilter_Impl.h +++ b/modules/juce_dsp/processors/juce_IIRFilter_Impl.h @@ -32,11 +32,10 @@ ============================================================================== */ +/** @cond */ namespace juce::dsp::IIR { -#ifndef DOXYGEN - template template Coefficients& Coefficients::assignImpl (const NumericType* values) @@ -244,6 +243,5 @@ void Filter::check() reset(); } -#endif - } // namespace juce::dsp::IIR +/** @endcond */ diff --git a/modules/juce_dsp/processors/juce_Oversampling.h b/modules/juce_dsp/processors/juce_Oversampling.h index ad8dc60de1..822f877985 100644 --- a/modules/juce_dsp/processors/juce_Oversampling.h +++ b/modules/juce_dsp/processors/juce_Oversampling.h @@ -198,9 +198,9 @@ public: size_t factorOversampling = 1; size_t numChannels = 1; - #ifndef DOXYGEN + /** @cond */ struct OversamplingStage; - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_dsp/processors/juce_ProcessorChain.h b/modules/juce_dsp/processors/juce_ProcessorChain.h index c637a22029..86ed604668 100644 --- a/modules/juce_dsp/processors/juce_ProcessorChain.h +++ b/modules/juce_dsp/processors/juce_ProcessorChain.h @@ -35,8 +35,8 @@ namespace juce::dsp { +/** @cond */ //============================================================================== -#ifndef DOXYGEN /** The contents of this namespace are used to implement ProcessorChain and should not be used elsewhere. Their interfaces (and existence) are liable to change! */ @@ -60,7 +60,7 @@ namespace detail template inline constexpr auto useContextDirectly = ! Context::usesSeparateInputAndOutputBlocks() || Ix == 0; } -#endif +/** @endcond */ /** This variadically-templated class lets you join together any number of processor classes into a single processor which will call process() on them all in sequence. @@ -168,7 +168,7 @@ inline bool isBypassed (const ProcessorChain& chain) noexcept } // namespace juce::dsp -#ifndef DOXYGEN +/** @cond */ namespace std { @@ -185,4 +185,4 @@ struct tuple_element> : tuple_elem JUCE_END_IGNORE_WARNINGS_GCC_LIKE } // namespace std -#endif +/** @endcond */ diff --git a/modules/juce_dsp/processors/juce_StateVariableFilter.h b/modules/juce_dsp/processors/juce_StateVariableFilter.h index b360102320..e615b57c84 100644 --- a/modules/juce_dsp/processors/juce_StateVariableFilter.h +++ b/modules/juce_dsp/processors/juce_StateVariableFilter.h @@ -74,7 +74,7 @@ namespace juce::dsp::StateVariableFilter using ParametersPtr = typename Parameters::Ptr; //============================================================================== - #ifndef DOXYGEN + /** @cond */ /** Creates a filter with default parameters. */ [[deprecated ("The classes in the StateVariableFilter namespace are deprecated. you should " "use the equivalent functionality in the StateVariableTPTFilter class.")]] @@ -84,7 +84,7 @@ namespace juce::dsp::StateVariableFilter [[deprecated ("The classes in the StateVariableFilter namespace are deprecated. you should " "use the equivalent functionality in the StateVariableTPTFilter class.")]] Filter (ParametersPtr parametersToUse) : parameters (std::move (parametersToUse)) { reset(); } - #endif + /** @endcond */ /** Creates a copy of another filter. */ Filter (const Filter&) = default; diff --git a/modules/juce_events/interprocess/juce_ChildProcessManager.h b/modules/juce_events/interprocess/juce_ChildProcessManager.h index caf3994e6e..c458349877 100644 --- a/modules/juce_events/interprocess/juce_ChildProcessManager.h +++ b/modules/juce_events/interprocess/juce_ChildProcessManager.h @@ -56,9 +56,9 @@ namespace juce class JUCE_API ChildProcessManager final : private DeletedAtShutdown { public: - #ifndef DOXYGEN + /** @cond */ JUCE_DECLARE_SINGLETON_SINGLETHREADED_MINIMAL_INLINE (ChildProcessManager) - #endif + /** @endcond */ /** Creates a new ChildProcess and starts it with the provided arguments. diff --git a/modules/juce_events/messages/juce_ApplicationBase.h b/modules/juce_events/messages/juce_ApplicationBase.h index 65682f8377..3635f281c3 100644 --- a/modules/juce_events/messages/juce_ApplicationBase.h +++ b/modules/juce_events/messages/juce_ApplicationBase.h @@ -288,7 +288,7 @@ public: //============================================================================== - #ifndef DOXYGEN + /** @cond */ // The following methods are for internal use only... static int main(); static int main (int argc, const char* argv[]); @@ -305,7 +305,7 @@ public: int shutdownApp(); static void JUCE_CALLTYPE sendUnhandledException (const std::exception*, const char* sourceFile, int lineNumber); bool sendCommandLineToPreexistingInstance(); - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_events/messages/juce_MessageManager.h b/modules/juce_events/messages/juce_MessageManager.h index 0c63acc209..762c98df66 100644 --- a/modules/juce_events/messages/juce_MessageManager.h +++ b/modules/juce_events/messages/juce_MessageManager.h @@ -389,11 +389,11 @@ public: }; //============================================================================== - #ifndef DOXYGEN // Internal methods - do not use! + /** @cond */ void deliverBroadcastMessage (const String&); ~MessageManager() noexcept; - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_graphics/colour/juce_PixelFormats.h b/modules/juce_graphics/colour/juce_PixelFormats.h index cd5bc4d168..70ebf300da 100644 --- a/modules/juce_graphics/colour/juce_PixelFormats.h +++ b/modules/juce_graphics/colour/juce_PixelFormats.h @@ -343,9 +343,9 @@ private: Components components; }; } -#ifndef DOXYGEN - JUCE_PACKED -#endif +/** @cond */ +JUCE_PACKED +/** @endcond */ ; @@ -585,9 +585,9 @@ private: #endif } -#ifndef DOXYGEN - JUCE_PACKED -#endif +/** @cond */ +JUCE_PACKED +/** @endcond */ ; forcedinline void PixelARGB::blend (PixelRGB src) noexcept @@ -737,9 +737,9 @@ private: //============================================================================== uint8 a; } -#ifndef DOXYGEN +/** @cond */ JUCE_PACKED -#endif +/** @endcond */ ; #if JUCE_MSVC diff --git a/modules/juce_graphics/fonts/juce_FunctionPointerDestructor.h b/modules/juce_graphics/fonts/juce_FunctionPointerDestructor.h index 8855d1f974..3313f1dd0e 100644 --- a/modules/juce_graphics/fonts/juce_FunctionPointerDestructor.h +++ b/modules/juce_graphics/fonts/juce_FunctionPointerDestructor.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce { @@ -49,5 +48,4 @@ struct FunctionPointerDestructor }; } // namespace juce - -#endif +/** @endcond */ diff --git a/modules/juce_graphics/fonts/juce_TypefaceFileCache.h b/modules/juce_graphics/fonts/juce_TypefaceFileCache.h index 6a1444d37c..da8996a47a 100644 --- a/modules/juce_graphics/fonts/juce_TypefaceFileCache.h +++ b/modules/juce_graphics/fonts/juce_TypefaceFileCache.h @@ -32,8 +32,7 @@ ============================================================================== */ -#ifndef DOXYGEN - +/** @cond */ namespace juce { @@ -68,5 +67,4 @@ private: }; } // namespace juce - -#endif +/** @endcond */ diff --git a/modules/juce_graphics/geometry/juce_AffineTransform.h b/modules/juce_graphics/geometry/juce_AffineTransform.h index 0e9d182355..7bdce3d408 100644 --- a/modules/juce_graphics/geometry/juce_AffineTransform.h +++ b/modules/juce_graphics/geometry/juce_AffineTransform.h @@ -278,7 +278,7 @@ public: float getDeterminant() const noexcept; //============================================================================== - #ifndef DOXYGEN + /** @cond */ /** This method has been deprecated. You can calculate the scale factor using: @@ -298,7 +298,7 @@ public: [[deprecated ("If you need an identity transform, just use AffineTransform() or {}.")]] static const AffineTransform identity; - #endif + /** @endcond */ //============================================================================== /* The transform matrix is: diff --git a/modules/juce_graphics/geometry/juce_Rectangle.h b/modules/juce_graphics/geometry/juce_Rectangle.h index 898359a282..42b8248d9f 100644 --- a/modules/juce_graphics/geometry/juce_Rectangle.h +++ b/modules/juce_graphics/geometry/juce_Rectangle.h @@ -35,7 +35,7 @@ namespace juce { -#ifndef DOXYGEN +/** @cond */ namespace detail { @@ -61,7 +61,7 @@ inline int ceilAsInt (float n) noexcept { return n < (float) std::numeric_li inline int ceilAsInt (double n) noexcept { return n < (double) std::numeric_limits::max() ? (int) std::ceil (n) : std::numeric_limits::max(); } } // namespace detail -#endif +/** @endcond */ //============================================================================== /** @@ -1013,10 +1013,10 @@ public: detail::parseAfterSpace (toks[3]) }; } - #ifndef DOXYGEN + /** @cond */ [[deprecated ("This has been renamed to transformedBy in order to match the method names used in the Point class.")]] Rectangle transformed (const AffineTransform& t) const noexcept { return transformedBy (t); } - #endif + /** @endcond */ private: template friend class Rectangle; diff --git a/modules/juce_graphics/images/juce_Image.h b/modules/juce_graphics/images/juce_Image.h index eada8c900c..89b9354c94 100644 --- a/modules/juce_graphics/images/juce_Image.h +++ b/modules/juce_graphics/images/juce_Image.h @@ -448,10 +448,12 @@ public: explicit Image (ReferenceCountedObjectPtr) noexcept; //============================================================================== - #if JUCE_ALLOW_STATIC_NULL_VARIABLES && ! defined (DOXYGEN) + #if JUCE_ALLOW_STATIC_NULL_VARIABLES + /** @cond */ /* A null Image object that can be used when you need to return an invalid image. */ [[deprecated ("If you need a default-constructed var, just use Image() or {}.")]] static const Image null; + /** @endcond */ #endif private: diff --git a/modules/juce_gui_basics/buttons/juce_Button.h b/modules/juce_gui_basics/buttons/juce_Button.h index 151a1fc6ea..036ab09833 100644 --- a/modules/juce_gui_basics/buttons/juce_Button.h +++ b/modules/juce_gui_basics/buttons/juce_Button.h @@ -426,10 +426,10 @@ public: }; //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("This method's parameters have changed.")]] void setToggleState (bool, bool); - #endif + /** @endcond */ protected: //============================================================================== diff --git a/modules/juce_gui_basics/components/juce_Component.h b/modules/juce_gui_basics/components/juce_Component.h index 0543b3869a..97c42bc144 100644 --- a/modules/juce_gui_basics/components/juce_Component.h +++ b/modules/juce_gui_basics/components/juce_Component.h @@ -2627,7 +2627,7 @@ public: virtual std::unique_ptr createAccessibilityHandler(); //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("Use the setFocusContainerType that takes a more descriptive enum.")]] void setFocusContainer (bool shouldBeFocusContainer) noexcept { @@ -2637,7 +2637,7 @@ public: [[deprecated ("Use the contains that takes a Point.")]] void contains (int, int) = delete; - #endif + /** @endcond */ private: @@ -2645,7 +2645,7 @@ private: friend class ComponentPeer; friend class detail::MouseInputSourceImpl; - #ifndef DOXYGEN + /** @cond */ static Component* currentlyFocusedComponent; //============================================================================== @@ -2758,7 +2758,7 @@ protected: virtual ComponentPeer* createNewPeer (int styleFlags, void* nativeWindowToAttachTo); /** @internal */ static std::unique_ptr createIgnoredAccessibilityHandler (Component&); - #endif + /** @endcond */ }; } // namespace juce diff --git a/modules/juce_gui_basics/components/juce_ModalComponentManager.h b/modules/juce_gui_basics/components/juce_ModalComponentManager.h index f0a043379b..cafed82074 100644 --- a/modules/juce_gui_basics/components/juce_ModalComponentManager.h +++ b/modules/juce_gui_basics/components/juce_ModalComponentManager.h @@ -84,9 +84,9 @@ public: }; //============================================================================== - #ifndef DOXYGEN + /** @cond */ JUCE_DECLARE_SINGLETON_SINGLETHREADED_MINIMAL_INLINE (ModalComponentManager) - #endif + /** @endcond */ //============================================================================== /** Returns the number of components currently being shown modally. diff --git a/modules/juce_gui_basics/desktop/juce_Desktop.h b/modules/juce_gui_basics/desktop/juce_Desktop.h index 5c3d47e3e0..e6e7454626 100644 --- a/modules/juce_gui_basics/desktop/juce_Desktop.h +++ b/modules/juce_gui_basics/desktop/juce_Desktop.h @@ -406,10 +406,12 @@ public: /** True if the OS supports semitransparent windows */ static bool canUseSemiTransparentWindows() noexcept; - #if JUCE_MAC && ! defined (DOXYGEN) + #if JUCE_MAC + /** @cond */ [[deprecated ("This macOS-specific method has been deprecated in favour of the cross-platform " " isDarkModeActive() method.")]] static bool isOSXDarkModeActive() { return Desktop::getInstance().isDarkModeActive(); } + /** @endcond */ #endif /** Returns true if the desktop environment allows resizing the window by clicking and dragging diff --git a/modules/juce_gui_basics/desktop/juce_Displays.cpp b/modules/juce_gui_basics/desktop/juce_Displays.cpp index e61de1cff8..624bd58fd5 100644 --- a/modules/juce_gui_basics/desktop/juce_Displays.cpp +++ b/modules/juce_gui_basics/desktop/juce_Displays.cpp @@ -383,14 +383,14 @@ void Displays::updateToLogical() } } -#ifndef DOXYGEN - // explicit template instantiations - template Point Displays::physicalToLogical (Point, const Display*) const noexcept; - template Point Displays::physicalToLogical (Point, const Display*) const noexcept; +/** @cond */ +// explicit template instantiations +template Point Displays::physicalToLogical (Point, const Display*) const noexcept; +template Point Displays::physicalToLogical (Point, const Display*) const noexcept; - template Point Displays::logicalToPhysical (Point, const Display*) const noexcept; - template Point Displays::logicalToPhysical (Point, const Display*) const noexcept; -#endif +template Point Displays::logicalToPhysical (Point, const Display*) const noexcept; +template Point Displays::logicalToPhysical (Point, const Display*) const noexcept; +/** @endcond */ //============================================================================== // Deprecated methods diff --git a/modules/juce_gui_basics/desktop/juce_Displays.h b/modules/juce_gui_basics/desktop/juce_Displays.h index e047b96e80..3ed927a19c 100644 --- a/modules/juce_gui_basics/desktop/juce_Displays.h +++ b/modules/juce_gui_basics/desktop/juce_Displays.h @@ -211,7 +211,7 @@ public: /** An Array containing the Display objects for all of the connected displays. */ Array displays; - #ifndef DOXYGEN + /** @cond */ /** @internal */ void refresh(); @@ -224,7 +224,7 @@ public: [[deprecated]] const Display& findDisplayForRect (Rectangle, bool isPhysical = false) const noexcept; [[deprecated]] const Display& findDisplayForPoint (Point, bool isPhysical = false) const noexcept; [[deprecated]] const Display& getMainDisplay() const noexcept; - #endif + /** @endcond */ private: friend class Desktop; diff --git a/modules/juce_gui_basics/drawables/juce_Drawable.h b/modules/juce_gui_basics/drawables/juce_Drawable.h index eaf0a2e7f7..ed04be5d4e 100644 --- a/modules/juce_gui_basics/drawables/juce_Drawable.h +++ b/modules/juce_gui_basics/drawables/juce_Drawable.h @@ -35,7 +35,7 @@ namespace juce { -#ifndef DOXYGEN +/** @cond */ namespace detail { class BoundsChangeListener final : private ComponentListener @@ -60,7 +60,7 @@ private: ErasedScopeGuard componentListenerGuard; }; } // namespace detail -#endif +/** @endcond */ //============================================================================== /** diff --git a/modules/juce_gui_basics/filebrowser/juce_FileChooser.h b/modules/juce_gui_basics/filebrowser/juce_FileChooser.h index e5973065dd..6c8da6c969 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FileChooser.h +++ b/modules/juce_gui_basics/filebrowser/juce_FileChooser.h @@ -316,9 +316,9 @@ public: const String& fileExtension); //============================================================================== - #ifndef DOXYGEN + /** @cond */ class Native; - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_gui_basics/menus/juce_PopupMenu.h b/modules/juce_gui_basics/menus/juce_PopupMenu.h index a8234453e9..2bd58a77a9 100644 --- a/modules/juce_gui_basics/menus/juce_PopupMenu.h +++ b/modules/juce_gui_basics/menus/juce_PopupMenu.h @@ -1050,10 +1050,10 @@ public: }; //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("Use the new method.")]] int drawPopupMenuItem (Graphics&, int, int, bool, bool, bool, bool, bool, const String&, const String&, Image*, const Colour*) { return 0; } - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_gui_basics/mouse/juce_MouseInputSource.h b/modules/juce_gui_basics/mouse/juce_MouseInputSource.h index a49ccc7f70..ffc893df87 100644 --- a/modules/juce_gui_basics/mouse/juce_MouseInputSource.h +++ b/modules/juce_gui_basics/mouse/juce_MouseInputSource.h @@ -285,13 +285,13 @@ public: static const Point offscreenMousePos; //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("This method has been replaced with the isLongPressOrDrag and hasMovedSignificantlySincePressed " "methods. If you want the same behaviour you should use isLongPressOrDrag which accounts for the " "amount of time that the input source has been held down for, but if you only want to know whether " "it has been moved use hasMovedSignificantlySincePressed instead.")]] bool hasMouseMovedSignificantlySincePressed() const noexcept; - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_gui_basics/widgets/juce_ComboBox.h b/modules/juce_gui_basics/widgets/juce_ComboBox.h index 3e427fbe8c..ca0c89a9ae 100644 --- a/modules/juce_gui_basics/widgets/juce_ComboBox.h +++ b/modules/juce_gui_basics/widgets/juce_ComboBox.h @@ -432,13 +432,13 @@ public: std::unique_ptr createAccessibilityHandler() override; //============================================================================== - #ifndef DOXYGEN + /** @cond */ // These methods' bool parameters have changed: see their new method signatures. [[deprecated]] void clear (bool); [[deprecated]] void setSelectedId (int, bool); [[deprecated]] void setSelectedItemIndex (int, bool); [[deprecated]] void setText (const String&, bool); - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_gui_basics/widgets/juce_ListBox.h b/modules/juce_gui_basics/widgets/juce_ListBox.h index 9d73dbedf8..098b9cfa00 100644 --- a/modules/juce_gui_basics/widgets/juce_ListBox.h +++ b/modules/juce_gui_basics/widgets/juce_ListBox.h @@ -616,13 +616,13 @@ public: std::unique_ptr createAccessibilityHandler() override; //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("This method's bool parameter has changed: see the new method signature.")]] void setSelectedRows (const SparseSet&, bool); - #endif [[deprecated ("The name of this function is ambiguous if derived classes supply their own models, use getListBoxModel instead")]] ListBoxModel* getModel() const noexcept { return getListBoxModel(); } + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_gui_basics/widgets/juce_Slider.h b/modules/juce_gui_basics/widgets/juce_Slider.h index 0a720a3ede..7827c6ab6c 100644 --- a/modules/juce_gui_basics/widgets/juce_Slider.h +++ b/modules/juce_gui_basics/widgets/juce_Slider.h @@ -1024,7 +1024,7 @@ public: std::unique_ptr createAccessibilityHandler() override; //============================================================================== - #ifndef DOXYGEN + /** @cond */ // These methods' bool parameters have changed: see the new method signature. [[deprecated]] void setValue (double, bool); [[deprecated]] void setValue (double, bool, bool); @@ -1036,7 +1036,7 @@ public: [[deprecated]] void setMaxValue (double, bool); [[deprecated]] void setMinAndMaxValues (double, double, bool, bool); [[deprecated]] void setMinAndMaxValues (double, double, bool); - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_gui_basics/windows/juce_AlertWindow.h b/modules/juce_gui_basics/windows/juce_AlertWindow.h index 91b132f14c..add715c1ea 100644 --- a/modules/juce_gui_basics/windows/juce_AlertWindow.h +++ b/modules/juce_gui_basics/windows/juce_AlertWindow.h @@ -481,7 +481,8 @@ public: std::function callback); //============================================================================== - #if JUCE_MODAL_LOOPS_PERMITTED && ! defined (DOXYGEN) + #if JUCE_MODAL_LOOPS_PERMITTED + /** @cond */ /** Shows an operating-system native dialog box. @param title the title to use at the top @@ -494,6 +495,7 @@ public: static bool JUCE_CALLTYPE showNativeDialogBox (const String& title, const String& bodyText, bool isOkCancel); + /** @endcond */ #endif diff --git a/modules/juce_gui_basics/windows/juce_DocumentWindow.h b/modules/juce_gui_basics/windows/juce_DocumentWindow.h index 8d5bae804e..70a2c48bcc 100644 --- a/modules/juce_gui_basics/windows/juce_DocumentWindow.h +++ b/modules/juce_gui_basics/windows/juce_DocumentWindow.h @@ -271,7 +271,7 @@ public: }; //============================================================================== - #ifndef DOXYGEN + /** @cond */ /** @internal */ void paint (Graphics&) override; /** @internal */ @@ -300,7 +300,7 @@ public: void windowControlClickedMinimise() override; /** @internal */ void windowControlClickedMaximise() override; - #endif + /** @endcond */ private: //============================================================================== diff --git a/modules/juce_gui_basics/windows/juce_ResizableWindow.h b/modules/juce_gui_basics/windows/juce_ResizableWindow.h index d053cf2ab7..241bb54f89 100644 --- a/modules/juce_gui_basics/windows/juce_ResizableWindow.h +++ b/modules/juce_gui_basics/windows/juce_ResizableWindow.h @@ -322,12 +322,12 @@ public: }; //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("use setContentOwned and setContentNonOwned instead.")]] void setContentComponent (Component* newContentComponent, bool deleteOldOne = true, bool resizeToFit = false); - #endif + /** @endcond */ using TopLevelWindow::addToDesktop; diff --git a/modules/juce_gui_extra/misc/juce_LiveConstantEditor.h b/modules/juce_gui_extra/misc/juce_LiveConstantEditor.h index 0b5f052cf5..c3e1858d7c 100644 --- a/modules/juce_gui_extra/misc/juce_LiveConstantEditor.h +++ b/modules/juce_gui_extra/misc/juce_LiveConstantEditor.h @@ -32,8 +32,9 @@ ============================================================================== */ -#if JUCE_ENABLE_LIVE_CONSTANT_EDITOR && ! defined (DOXYGEN) +#if JUCE_ENABLE_LIVE_CONSTANT_EDITOR +/** @cond */ //============================================================================== /** You can safely ignore all the stuff in this namespace - it's a bunch of boilerplate code used to implement the JUCE_LIVE_CONSTANT functionality. @@ -251,6 +252,7 @@ namespace juce::LiveConstantEditor } } // namespace juce::LiveConstantEditor +/** @endcond */ #endif diff --git a/modules/juce_gui_extra/misc/juce_PushNotifications.h b/modules/juce_gui_extra/misc/juce_PushNotifications.h index b5bafe2511..a615eb1011 100644 --- a/modules/juce_gui_extra/misc/juce_PushNotifications.h +++ b/modules/juce_gui_extra/misc/juce_PushNotifications.h @@ -54,9 +54,9 @@ namespace juce class JUCE_API PushNotifications : private DeletedAtShutdown { public: - #ifndef DOXYGEN + /** @cond */ JUCE_DECLARE_SINGLETON_INLINE (PushNotifications, false) - #endif + /** @endcond */ //============================================================================== /** Represents a notification that can be sent or received. */ diff --git a/modules/juce_midi_ci/ci/juce_CIEncoding.h b/modules/juce_midi_ci/ci/juce_CIEncoding.h index f0220973a8..9d8d19ac77 100644 --- a/modules/juce_midi_ci/ci/juce_CIEncoding.h +++ b/modules/juce_midi_ci/ci/juce_CIEncoding.h @@ -88,8 +88,7 @@ struct EncodingUtils } // namespace juce::midi_ci -#ifndef DOXYGEN - +/** @cond */ namespace juce { template <> @@ -113,5 +112,4 @@ namespace juce }; } // namespace juce - -#endif // ifndef DOXYGEN +/** @endcond */ diff --git a/modules/juce_midi_ci/ci/juce_CIPropertyDelegate.h b/modules/juce_midi_ci/ci/juce_CIPropertyDelegate.h index 34f9cbc0db..995820649a 100644 --- a/modules/juce_midi_ci/ci/juce_CIPropertyDelegate.h +++ b/modules/juce_midi_ci/ci/juce_CIPropertyDelegate.h @@ -258,8 +258,7 @@ struct PropertyDelegate } // namespace juce::midi_ci -#ifndef DOXYGEN - +/** @cond */ namespace juce { @@ -284,5 +283,4 @@ struct SerialisationTraits }; } // namespace juce - -#endif // ifndef DOXYGEN +/** @endcond */ diff --git a/modules/juce_midi_ci/detail/juce_CIMessageMeta.h b/modules/juce_midi_ci/detail/juce_CIMessageMeta.h index 01d7b514d1..b2d264b565 100644 --- a/modules/juce_midi_ci/detail/juce_CIMessageMeta.h +++ b/modules/juce_midi_ci/detail/juce_CIMessageMeta.h @@ -181,8 +181,7 @@ struct Meta : Metadata<0x44> {}; } // namespace juce::midi_ci::detail::MessageMeta -#ifndef DOXYGEN - +/** @cond */ namespace juce { @@ -628,5 +627,4 @@ struct SerialisationTraits : VersionBa }; } // namespace juce - -#endif // ifndef DOXYGEN +/** @endcond */ diff --git a/modules/juce_opengl/native/juce_OpenGLExtensions.h b/modules/juce_opengl/native/juce_OpenGLExtensions.h index 182dd226ed..0555d41e48 100644 --- a/modules/juce_opengl/native/juce_OpenGLExtensions.h +++ b/modules/juce_opengl/native/juce_OpenGLExtensions.h @@ -118,16 +118,18 @@ namespace juce struct OpenGLExtensionFunctions { //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("A more complete set of GL commands can be found in the juce::gl namespace. " "You should use juce::gl::loadFunctions() to load GL functions.")]] static void initialise(); - #endif + /** @endcond */ - #if JUCE_WINDOWS && ! defined (DOXYGEN) + #if JUCE_WINDOWS + /** @cond */ typedef char GLchar; typedef pointer_sized_int GLsizeiptr; typedef pointer_sized_int GLintptr; + /** @endcond */ #endif #define X(name) static decltype (::juce::gl::name)& name; diff --git a/modules/juce_opengl/opengl/juce_OpenGLContext.h b/modules/juce_opengl/opengl/juce_OpenGLContext.h index 0ea7aaa0cd..f0e552e6f7 100644 --- a/modules/juce_opengl/opengl/juce_OpenGLContext.h +++ b/modules/juce_opengl/opengl/juce_OpenGLContext.h @@ -346,10 +346,10 @@ public: size_t getImageCacheSize() const noexcept; //============================================================================== - #ifndef DOXYGEN + /** @cond */ class NativeContext; class NativeContextListener; - #endif + /** @endcond */ private: enum class InitResult @@ -401,9 +401,9 @@ private: }; //============================================================================== -#ifndef DOXYGEN +/** @cond */ template void OpenGLContext::executeOnGLThread (FunctionType&& f, bool shouldBlock) { execute (new AsyncWorkerFunctor (f), shouldBlock); } -#endif +/** @endcond */ } // namespace juce diff --git a/modules/juce_product_unlocking/in_app_purchases/juce_InAppPurchases.h b/modules/juce_product_unlocking/in_app_purchases/juce_InAppPurchases.h index 9e7718b66a..a3983efaf9 100644 --- a/modules/juce_product_unlocking/in_app_purchases/juce_InAppPurchases.h +++ b/modules/juce_product_unlocking/in_app_purchases/juce_InAppPurchases.h @@ -49,9 +49,9 @@ namespace juce class JUCE_API InAppPurchases : private DeletedAtShutdown { public: - #ifndef DOXYGEN + /** @cond */ JUCE_DECLARE_SINGLETON_INLINE (InAppPurchases, false) - #endif + /** @endcond */ //============================================================================== /** Represents a product available in the store. */ @@ -265,7 +265,7 @@ public: void cancelDownloads (const Array& downloads); //============================================================================== - #ifndef DOXYGEN + /** @cond */ [[deprecated ("On Android, it is no longer necessary to specify whether the product being purchased is a subscription " "and only a single subscription can be upgraded/downgraded. Use the updated purchaseProduct method " "which takes a single String argument.")]] @@ -278,14 +278,14 @@ public: upgradeOrDowngradeFromSubscriptionsWithProductIdentifiers[0], creditForUnusedSubscription); } - #endif + /** @endcond */ private: //============================================================================== - #ifndef DOXYGEN + /** @cond */ InAppPurchases(); ~InAppPurchases(); - #endif + /** @endcond */ //============================================================================== ListenerList listeners;