mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-10 23:44:24 +00:00
Doxygen updates
This commit is contained in:
parent
c9f0f7efa2
commit
2c7043319b
5 changed files with 25 additions and 10 deletions
|
|
@ -319,6 +319,7 @@ private:
|
||||||
pair somewhere that requires an iterable range, such as in a ranged-for loop.
|
pair somewhere that requires an iterable range, such as in a ranged-for loop.
|
||||||
|
|
||||||
@see makeRange()
|
@see makeRange()
|
||||||
|
@tags{Core}
|
||||||
*/
|
*/
|
||||||
template <typename Begin, typename End>
|
template <typename Begin, typename End>
|
||||||
class IteratorPair
|
class IteratorPair
|
||||||
|
|
|
||||||
|
|
@ -79,6 +79,8 @@ struct EncodingUtils
|
||||||
|
|
||||||
} // namespace juce::midi_ci
|
} // namespace juce::midi_ci
|
||||||
|
|
||||||
|
#ifndef DOXYGEN
|
||||||
|
|
||||||
namespace juce
|
namespace juce
|
||||||
{
|
{
|
||||||
template <>
|
template <>
|
||||||
|
|
@ -102,3 +104,5 @@ namespace juce
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace juce
|
} // namespace juce
|
||||||
|
|
||||||
|
#endif // ifndef DOXYGEN
|
||||||
|
|
|
||||||
|
|
@ -43,6 +43,11 @@ enum class PropertySubscriptionCommand
|
||||||
#undef X
|
#undef X
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
Functions to use with PropertySubscriptionCommand.
|
||||||
|
|
||||||
|
@tags{Audio}
|
||||||
|
*/
|
||||||
struct PropertySubscriptionCommandUtils
|
struct PropertySubscriptionCommandUtils
|
||||||
{
|
{
|
||||||
PropertySubscriptionCommandUtils() = delete;
|
PropertySubscriptionCommandUtils() = delete;
|
||||||
|
|
@ -244,6 +249,8 @@ struct PropertyDelegate
|
||||||
|
|
||||||
} // namespace juce::midi_ci
|
} // namespace juce::midi_ci
|
||||||
|
|
||||||
|
#ifndef DOXYGEN
|
||||||
|
|
||||||
namespace juce
|
namespace juce
|
||||||
{
|
{
|
||||||
|
|
||||||
|
|
@ -268,3 +275,5 @@ struct SerialisationTraits<midi_ci::PropertySubscriptionCommand>
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace juce
|
} // namespace juce
|
||||||
|
|
||||||
|
#endif // ifndef DOXYGEN
|
||||||
|
|
|
||||||
|
|
@ -44,7 +44,9 @@ public:
|
||||||
JUCE_DECLARE_NON_COPYABLE (InitiatorPropertyExchangeCache)
|
JUCE_DECLARE_NON_COPYABLE (InitiatorPropertyExchangeCache)
|
||||||
|
|
||||||
/** Holds a token that can be used to stop waiting for a reply, along with
|
/** 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
|
struct TokenAndId
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -36,9 +36,7 @@ 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 };
|
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
|
||||||
|
|
||||||
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.
|
of variable length, starting with a 16-bit or 32-bit byte count.
|
||||||
*/
|
*/
|
||||||
template <uint8_t NumBytes, typename T, bool isJson = false>
|
template <uint8_t NumBytes, typename T, bool isJson = false>
|
||||||
|
|
@ -47,10 +45,7 @@ struct SpanWithSizeBytes
|
||||||
T& span;
|
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>
|
template <uint8_t NumBytes, typename T>
|
||||||
static constexpr auto makeSpanWithSizeBytes ( Span<T>& span) { return SpanWithSizeBytes<NumBytes, Span<T>> { span }; }
|
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
|
} // namespace juce::midi_ci::detail::MessageMeta
|
||||||
|
|
||||||
|
#ifndef DOXYGEN
|
||||||
|
|
||||||
namespace juce
|
namespace juce
|
||||||
{
|
{
|
||||||
|
|
||||||
|
|
@ -622,3 +619,5 @@ struct SerialisationTraits<ci::Message::ProcessEndMidiMessageReport> : VersionBa
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace juce
|
} // namespace juce
|
||||||
|
|
||||||
|
#endif // ifndef DOXYGEN
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue