Browse Source

Documentation fixes

tags/2021-05-28
Tom Poole 7 years ago
parent
commit
f1af3908d5
8 changed files with 28 additions and 4 deletions
  1. +4
    -0
      modules/juce_audio_processors/format_types/juce_VST3Common.h
  2. +1
    -0
      modules/juce_blocks_basics/blocks/juce_LEDGrid.h
  3. +1
    -1
      modules/juce_core/containers/juce_Variant.h
  4. +6
    -1
      modules/juce_core/maths/juce_MathsFunctions.h
  5. +5
    -0
      modules/juce_core/memory/juce_Atomic.h
  6. +4
    -0
      modules/juce_core/text/juce_CharacterFunctions.h
  7. +5
    -0
      modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V4.h
  8. +2
    -2
      modules/juce_gui_extra/misc/juce_PushNotifications.h

+ 4
- 0
modules/juce_audio_processors/format_types/juce_VST3Common.h View File

@@ -24,6 +24,8 @@
============================================================================== ==============================================================================
*/ */
#if ! DOXYGEN
namespace juce namespace juce
{ {
@@ -673,3 +675,5 @@ template <> struct VST3FloatAndDoubleBusMapCompositeHelper<double>
}; };
} // namespace juce } // namespace juce
#endif // ! DOXYGEN

+ 1
- 0
modules/juce_blocks_basics/blocks/juce_LEDGrid.h View File

@@ -68,6 +68,7 @@ public:
virtual int getNumRows() const = 0; virtual int getNumRows() const = 0;
//============================================================================== //==============================================================================
/** An interface to use for LEDGrid rendering. */
struct Renderer : public juce::ReferenceCountedObject struct Renderer : public juce::ReferenceCountedObject
{ {
virtual ~Renderer(); virtual ~Renderer();


+ 1
- 1
modules/juce_core/containers/juce_Variant.h View File

@@ -336,7 +336,7 @@ struct VariantConverter
static var toVar (const Type& t) { return t; } static var toVar (const Type& t) { return t; }
}; };
/** This template-overloaded class can be used to convert between var and custom types. */
/** @internal */
template <> template <>
struct VariantConverter<String> struct VariantConverter<String>
{ {


+ 6
- 1
modules/juce_core/maths/juce_MathsFunctions.h View File

@@ -643,17 +643,22 @@ namespace TypeHelpers
type; for anything else, they return a float type. type; for anything else, they return a float type.
*/ */
template <typename Type> struct SmallestFloatType { typedef float type; }; template <typename Type> struct SmallestFloatType { typedef float type; };
template <> struct SmallestFloatType <double> { typedef double type; };
#if ! DOXYGEN
template <> struct SmallestFloatType <double> { typedef double type; };
#endif
/** These templates are designed to take an integer type, and return an unsigned int /** These templates are designed to take an integer type, and return an unsigned int
version with the same size. version with the same size.
*/ */
template <int bytes> struct UnsignedTypeWithSize {}; template <int bytes> struct UnsignedTypeWithSize {};
#if ! DOXYGEN
template <> struct UnsignedTypeWithSize<1> { typedef uint8 type; }; template <> struct UnsignedTypeWithSize<1> { typedef uint8 type; };
template <> struct UnsignedTypeWithSize<2> { typedef uint16 type; }; template <> struct UnsignedTypeWithSize<2> { typedef uint16 type; };
template <> struct UnsignedTypeWithSize<4> { typedef uint32 type; }; template <> struct UnsignedTypeWithSize<4> { typedef uint32 type; };
template <> struct UnsignedTypeWithSize<8> { typedef uint64 type; }; template <> struct UnsignedTypeWithSize<8> { typedef uint64 type; };
#endif
} }
//============================================================================== //==============================================================================


+ 5
- 0
modules/juce_core/memory/juce_Atomic.h View File

@@ -152,6 +152,7 @@ namespace juce
#define JUCE_64BIT_ATOMICS_UNAVAILABLE 1 #define JUCE_64BIT_ATOMICS_UNAVAILABLE 1
#endif #endif
/** @internal */
template <typename Type> class AtomicBase; template <typename Type> class AtomicBase;
//============================================================================== //==============================================================================
@@ -258,6 +259,8 @@ namespace juce
static inline void memoryBarrier() noexcept { AtomicBase<Type>::memoryBarrier(); } static inline void memoryBarrier() noexcept { AtomicBase<Type>::memoryBarrier(); }
}; };
#if ! DOXYGEN
//============================================================================== //==============================================================================
// Internal implementation follows // Internal implementation follows
//============================================================================== //==============================================================================
@@ -416,6 +419,8 @@ namespace juce
template <typename Type> template <typename Type>
inline void AtomicBase<Type>::memoryBarrier() noexcept { __sync_synchronize(); } inline void AtomicBase<Type>::memoryBarrier() noexcept { __sync_synchronize(); }
#endif // ! DOXYGEN
#endif #endif
} // namespace juce } // namespace juce

+ 4
- 0
modules/juce_core/text/juce_CharacterFunctions.h View File

@@ -60,6 +60,8 @@ namespace juce
#define T(stringLiteral) JUCE_T(stringLiteral) #define T(stringLiteral) JUCE_T(stringLiteral)
#endif #endif
#if ! DOXYGEN
//============================================================================== //==============================================================================
// GNU libstdc++ does not have std::make_unsigned // GNU libstdc++ does not have std::make_unsigned
namespace internal namespace internal
@@ -73,6 +75,8 @@ namespace internal
template <> struct make_unsigned<long long> { typedef unsigned long long type; }; template <> struct make_unsigned<long long> { typedef unsigned long long type; };
} }
#endif
//============================================================================== //==============================================================================
/** /**
A collection of functions for manipulating characters and character strings. A collection of functions for manipulating characters and character strings.


+ 5
- 0
modules/juce_gui_basics/lookandfeel/juce_LookAndFeel_V4.h View File

@@ -27,6 +27,11 @@
namespace juce namespace juce
{ {
//==============================================================================
/**
The latest JUCE look-and-feel style, as introduced in 2017.
@see LookAndFeel, LookAndFeel_V1, LookAndFeel_V2, LookAndFeel_V3
*/
class JUCE_API LookAndFeel_V4 : public LookAndFeel_V3 class JUCE_API LookAndFeel_V4 : public LookAndFeel_V3
{ {
public: public:


+ 2
- 2
modules/juce_gui_extra/misc/juce_PushNotifications.h View File

@@ -60,7 +60,7 @@ public:
/** Represents an action on a notification that can be presented as a button or a text input. /** Represents an action on a notification that can be presented as a button or a text input.
On Android, each notification has its action specified explicitly, on iOS you configure an On Android, each notification has its action specified explicitly, on iOS you configure an
allowed set of actions on startup and pack them into categories (see @class Settings).
allowed set of actions on startup and pack them into categories (see Settings).
*/ */
struct Action struct Action
{ {
@@ -462,7 +462,7 @@ public:
Notification::LockScreenAppearance lockScreenAppearance = Notification::showPartially; /**< Optional. */ Notification::LockScreenAppearance lockScreenAppearance = Notification::showPartially; /**< Optional. */
String description; /**< Optional: user visible description of the channel. */ String description; /**< Optional: user visible description of the channel. */
String groupId; /**< Required: group this channel belongs to (see @class ChannelGroup). */
String groupId; /**< Required: group this channel belongs to (see ChannelGroup). */
Colour ledColour; /**< Optional: sets the led colour for notifications in this channel. */ Colour ledColour; /**< Optional: sets the led colour for notifications in this channel. */
bool bypassDoNotDisturb = false; /**< Optional: true if notifications in this channel can bypass do not disturb setting. */ bool bypassDoNotDisturb = false; /**< Optional: true if notifications in this channel can bypass do not disturb setting. */
bool canShowBadge = false; /**< Optional: true if notifications in this channel can show badges in a Launcher application. */ bool canShowBadge = false; /**< Optional: true if notifications in this channel can show badges in a Launcher application. */


Loading…
Cancel
Save