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

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

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

View file

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

View file

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

View file

@ -35,8 +35,7 @@
namespace juce
{
#ifndef DOXYGEN
/** @cond */
namespace detail
{
template <typename Ret, typename... Args>
@ -91,8 +90,7 @@ namespace detail
template <size_t len, typename T>
class FixedSizeFunction;
#endif
/** @endcond */
/**
A type similar to `std::function` that holds a callable object.

View file

@ -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<std::decay_t<Value>> makeOptional (Value&& v)
return std::forward<Value> (v);
}
#ifndef DOXYGEN
/** @cond */
#define X(op) \
template <typename T, typename U> bool operator op (const Optional<T>& lhs, const Optional<U>& rhs) { return lhs.opt op rhs.opt; } \
template <typename T> bool operator op (const Optional<T>& 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

View file

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

View file

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

View file

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