1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-09 23:34:20 +00:00

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

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

View file

@ -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<void*> (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

View file

@ -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 */
//==============================================================================
/**

View file

@ -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

View file

@ -880,7 +880,7 @@ public:
static MidiMessage createSysExMessage (Span<const std::byte> 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; }

View file

@ -47,11 +47,9 @@
#include "juce_UMPDispatcher.h"
#include "juce_UMPReceiver.h"
#ifndef DOXYGEN
/** @cond */
namespace juce
{
namespace ump = universal_midi_packets;
}
#endif
/** @endcond */

View file

@ -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 */

View file

@ -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 */

View file

@ -32,8 +32,7 @@
==============================================================================
*/
#ifndef DOXYGEN
/** @cond */
namespace juce::universal_midi_packets
{
@ -199,5 +198,4 @@ private:
};
} // namespace juce::universal_midi_packets
#endif
/** @endcond */

View file

@ -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 */

View file

@ -32,8 +32,7 @@
==============================================================================
*/
#ifndef DOXYGEN
/** @cond */
namespace juce::universal_midi_packets
{
@ -128,5 +127,4 @@ private:
};
} // namespace juce::universal_midi_packets
#endif
/** @endcond */

View file

@ -32,8 +32,7 @@
==============================================================================
*/
#ifndef DOXYGEN
/** @cond */
namespace juce::universal_midi_packets
{
@ -223,5 +222,4 @@ private:
};
} // namespace juce::universal_midi_packets
#endif
/** @endcond */

View file

@ -32,8 +32,7 @@
==============================================================================
*/
#ifndef DOXYGEN
/** @cond */
namespace juce::universal_midi_packets
{
@ -196,5 +195,4 @@ private:
};
} // namespace juce::universal_midi_packets
#endif
/** @endcond */

View file

@ -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 */

View file

@ -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 */

View file

@ -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 */

View file

@ -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 */

View file

@ -32,8 +32,7 @@
==============================================================================
*/
#ifndef DOXYGEN
/** @cond */
namespace juce::universal_midi_packets
{
@ -97,5 +96,4 @@ private:
};
} // namespace juce::universal_midi_packets
#endif
/** @endcond */

View file

@ -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 */

View file

@ -32,8 +32,7 @@
==============================================================================
*/
#ifndef DOXYGEN
/** @cond */
namespace juce::universal_midi_packets
{
@ -101,5 +100,4 @@ private:
};
} // namespace juce::universal_midi_packets
#endif
/** @endcond */

View file

@ -226,9 +226,9 @@ public:
/** Removes a listener. */
void removeListener (Listener* const listenerToRemove) noexcept;
#ifndef DOXYGEN
/** @cond */
using Zone = MPEZone;
#endif
/** @endcond */
private:
//==============================================================================

View file

@ -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 */

View file

@ -36,7 +36,7 @@
// This file will be included directly by macOS/iOS-specific .cpps
#pragma once
#if ! DOXYGEN
/** @cond */
#include <mach/mach_time.h>
@ -89,4 +89,4 @@ private:
} // namespace juce
#endif
/** @endcond */

View file

@ -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:
//==============================================================================