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
Sudara
parent
26e8d81380
commit
36d07a6ce3
136 changed files with 420 additions and 449 deletions
|
|
@ -35,7 +35,7 @@
|
|||
namespace juce::dsp
|
||||
{
|
||||
|
||||
#ifndef DOXYGEN
|
||||
/** @cond */
|
||||
namespace SampleTypeHelpers // Internal classes needed for handling sample type classes
|
||||
{
|
||||
template <typename T, bool = std::is_floating_point_v<T>>
|
||||
|
|
@ -56,7 +56,7 @@ namespace SampleTypeHelpers // Internal classes needed for handling sample type
|
|||
using Type = typename T::value_type;
|
||||
};
|
||||
}
|
||||
#endif
|
||||
/** @endcond */
|
||||
|
||||
//==============================================================================
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -35,11 +35,11 @@
|
|||
namespace juce::dsp
|
||||
{
|
||||
|
||||
#ifndef DOXYGEN
|
||||
// This class is needed internally.
|
||||
template <typename Scalar>
|
||||
struct CmplxSIMDOps;
|
||||
#endif
|
||||
/** @cond */
|
||||
// This class is needed internally.
|
||||
template <typename Scalar>
|
||||
struct CmplxSIMDOps;
|
||||
/** @endcond */
|
||||
|
||||
//==============================================================================
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -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<std::complex<Scalar>>
|
|||
return SIMDNativeOps<Scalar>::add (a, SIMDNativeOps<Scalar>::cmplxmul (b, c));
|
||||
}
|
||||
};
|
||||
#endif
|
||||
/** @endcond */
|
||||
|
||||
//==============================================================================
|
||||
namespace util
|
||||
|
|
|
|||
|
|
@ -118,11 +118,11 @@ public:
|
|||
int getSize() const noexcept { return size; }
|
||||
|
||||
//==============================================================================
|
||||
#ifndef DOXYGEN
|
||||
/* internal */
|
||||
/** @internal */
|
||||
/** @cond */
|
||||
struct Instance;
|
||||
template <typename> struct EngineImpl;
|
||||
#endif
|
||||
/** @endcond */
|
||||
|
||||
private:
|
||||
//==============================================================================
|
||||
|
|
|
|||
|
|
@ -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
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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<uint64_t>
|
|||
static forcedinline __m256i JUCE_VECTOR_CALLTYPE truncate (__m256i a) noexcept { return a; }
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
JUCE_END_IGNORE_WARNINGS_GCC_LIKE
|
||||
|
||||
} // namespace juce::dsp
|
||||
/** @endcond */
|
||||
|
|
|
|||
|
|
@ -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<class_type>:: name [16 / sizeof (type)] __attribute__ ((aligned (16)))
|
||||
|
||||
#endif
|
||||
#endif // _MSC_VER
|
||||
|
||||
template <typename type>
|
||||
struct SIMDNativeOps;
|
||||
|
|
@ -541,8 +540,8 @@ struct SIMDNativeOps<double>
|
|||
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 */
|
||||
|
|
|
|||
|
|
@ -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<class_type>:: name [16 / sizeof (type)] __attribute__ ((aligned (16)))
|
||||
|
||||
#endif
|
||||
#endif // _MSC_VER
|
||||
|
||||
template <typename type>
|
||||
struct SIMDNativeOps;
|
||||
|
|
@ -730,8 +729,7 @@ struct SIMDNativeOps<uint64_t>
|
|||
}
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
JUCE_END_IGNORE_WARNINGS_GCC_LIKE
|
||||
|
||||
} // namespace juce::dsp
|
||||
/** @endcond */
|
||||
|
|
|
|||
|
|
@ -32,11 +32,10 @@
|
|||
==============================================================================
|
||||
*/
|
||||
|
||||
/** @cond */
|
||||
namespace juce::dsp::IIR
|
||||
{
|
||||
|
||||
#ifndef DOXYGEN
|
||||
|
||||
template <typename NumericType>
|
||||
template <size_t Num>
|
||||
Coefficients<NumericType>& Coefficients<NumericType>::assignImpl (const NumericType* values)
|
||||
|
|
@ -244,6 +243,5 @@ void Filter<SampleType>::check()
|
|||
reset();
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
} // namespace juce::dsp::IIR
|
||||
/** @endcond */
|
||||
|
|
|
|||
|
|
@ -198,9 +198,9 @@ public:
|
|||
size_t factorOversampling = 1;
|
||||
size_t numChannels = 1;
|
||||
|
||||
#ifndef DOXYGEN
|
||||
/** @cond */
|
||||
struct OversamplingStage;
|
||||
#endif
|
||||
/** @endcond */
|
||||
|
||||
private:
|
||||
//==============================================================================
|
||||
|
|
|
|||
|
|
@ -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 <typename Context, size_t Ix>
|
||||
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<Processors...>& chain) noexcept
|
|||
|
||||
} // namespace juce::dsp
|
||||
|
||||
#ifndef DOXYGEN
|
||||
/** @cond */
|
||||
namespace std
|
||||
{
|
||||
|
||||
|
|
@ -185,4 +185,4 @@ struct tuple_element<I, ::juce::dsp::ProcessorChain<Processors...>> : tuple_elem
|
|||
JUCE_END_IGNORE_WARNINGS_GCC_LIKE
|
||||
|
||||
} // namespace std
|
||||
#endif
|
||||
/** @endcond */
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@ namespace juce::dsp::StateVariableFilter
|
|||
using ParametersPtr = typename Parameters<NumericType>::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;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue