Browse Source

Doxygen updates

v7.0.9
Tom Poole 1 year ago
parent
commit
2c7043319b
5 changed files with 25 additions and 10 deletions
  1. +1
    -0
      modules/juce_core/containers/juce_Enumerate.h
  2. +4
    -0
      modules/juce_midi_ci/ci/juce_CIEncoding.h
  3. +9
    -0
      modules/juce_midi_ci/ci/juce_CIPropertyDelegate.h
  4. +3
    -1
      modules/juce_midi_ci/ci/juce_CIPropertyExchangeCache.h
  5. +8
    -9
      modules/juce_midi_ci/detail/juce_CIMessageMeta.h

+ 1
- 0
modules/juce_core/containers/juce_Enumerate.h View File

@@ -319,6 +319,7 @@ private:
pair somewhere that requires an iterable range, such as in a ranged-for loop.
@see makeRange()
@tags{Core}
*/
template <typename Begin, typename End>
class IteratorPair


+ 4
- 0
modules/juce_midi_ci/ci/juce_CIEncoding.h View File

@@ -79,6 +79,8 @@ struct EncodingUtils
} // namespace juce::midi_ci
#ifndef DOXYGEN
namespace juce
{
template <>
@@ -102,3 +104,5 @@ namespace juce
};
} // namespace juce
#endif // ifndef DOXYGEN

+ 9
- 0
modules/juce_midi_ci/ci/juce_CIPropertyDelegate.h View File

@@ -43,6 +43,11 @@ enum class PropertySubscriptionCommand
#undef X
};
/**
Functions to use with PropertySubscriptionCommand.
@tags{Audio}
*/
struct PropertySubscriptionCommandUtils
{
PropertySubscriptionCommandUtils() = delete;
@@ -244,6 +249,8 @@ struct PropertyDelegate
} // namespace juce::midi_ci
#ifndef DOXYGEN
namespace juce
{
@@ -268,3 +275,5 @@ struct SerialisationTraits<midi_ci::PropertySubscriptionCommand>
};
} // namespace juce
#endif // ifndef DOXYGEN

+ 3
- 1
modules/juce_midi_ci/ci/juce_CIPropertyExchangeCache.h View File

@@ -44,7 +44,9 @@ public:
JUCE_DECLARE_NON_COPYABLE (InitiatorPropertyExchangeCache)
/** Holds a token that can be used to stop waiting for a reply, along with
an identifier byte which uniquely identifies an ongoing transaction.
an identifier byte that uniquely identifies an ongoing transaction.
@tags{Audio}
*/
struct TokenAndId
{


+ 8
- 9
modules/juce_midi_ci/detail/juce_CIMessageMeta.h View File

@@ -33,13 +33,11 @@ namespace juce::midi_ci::detail::MessageMeta
{
//==============================================================================
/* The maximum CI version that can be parsed and generated by this implementation. */
/* The maximum CI version that can be parsed and generated by this implementation. */
static constexpr std::byte implementationVersion { 0x02 };
/* @internal
Wraps a pointer to a Span. Used to indicate to CI readers/writers that a particular field is
of variable length, starting with a 16-bit or 32-bit byte count.
/* Wraps a pointer to a Span. Used to indicate to CI readers/writers that a particular field is
of variable length, starting with a 16-bit or 32-bit byte count.
*/
template <uint8_t NumBytes, typename T, bool isJson = false>
struct SpanWithSizeBytes
@@ -47,10 +45,7 @@ struct SpanWithSizeBytes
T& span;
};
/* @internal
Creates a SpanWithSizeBytes with an appropriate template argument.
*/
/* Creates a SpanWithSizeBytes with an appropriate template argument. */
template <uint8_t NumBytes, typename T>
static constexpr auto makeSpanWithSizeBytes ( Span<T>& span) { return SpanWithSizeBytes<NumBytes, Span<T>> { span }; }
@@ -177,6 +172,8 @@ struct Meta<Message::ProcessEndMidiMessageReport> : Metadata<0x44> {};
} // namespace juce::midi_ci::detail::MessageMeta
#ifndef DOXYGEN
namespace juce
{
@@ -622,3 +619,5 @@ struct SerialisationTraits<ci::Message::ProcessEndMidiMessageReport> : VersionBa
};
} // namespace juce
#endif // ifndef DOXYGEN

Loading…
Cancel
Save