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

Add some missing Doxygen tags

This commit is contained in:
Tom Poole 2021-09-20 11:36:56 +01:00
parent d6633e6b37
commit f1fecfdc88
7 changed files with 24 additions and 0 deletions

View file

@ -27,6 +27,8 @@ namespace universal_midi_packets
/**
A base class for classes which receive Universal MIDI Packets from an input.
@tags{Audio}
*/
struct Receiver
{

View file

@ -27,6 +27,8 @@ namespace universal_midi_packets
/**
Holds a single Universal MIDI Packet.
@tags{Audio}
*/
template <size_t numWords>
class Packet

View file

@ -27,6 +27,8 @@ namespace universal_midi_packets
/**
A base class for classes which convert bytestream midi to other formats.
@tags{Audio}
*/
struct BytestreamInputHandler
{
@ -39,6 +41,8 @@ struct BytestreamInputHandler
/**
Parses a continuous bytestream and emits complete MidiMessages whenever a full
message is received.
@tags{Audio}
*/
struct BytestreamToBytestreamHandler : public BytestreamInputHandler
{
@ -86,6 +90,8 @@ struct BytestreamToBytestreamHandler : public BytestreamInputHandler
/**
Parses a continuous MIDI 1.0 bytestream, and emits full messages in the requested
UMP format.
@tags{Audio}
*/
struct BytestreamToUMPHandler : public BytestreamInputHandler
{

View file

@ -28,6 +28,8 @@ namespace universal_midi_packets
/**
A base class for classes which convert Universal MIDI Packets to other
formats.
@tags{Audio}
*/
struct U32InputHandler
{
@ -40,6 +42,8 @@ struct U32InputHandler
/**
Parses a continuous stream of U32 words and emits complete MidiMessages whenever a full
message is received.
@tags{Audio}
*/
struct U32ToBytestreamHandler : public U32InputHandler
{
@ -90,6 +94,8 @@ struct U32ToBytestreamHandler : public U32InputHandler
/**
Parses a continuous stream of U32 words and emits full messages in the requested
UMP format.
@tags{Audio}
*/
struct U32ToUMPHandler : public U32InputHandler
{

View file

@ -31,6 +31,8 @@ namespace juce
You can choose to create a standard PopupMenu to display the host-provided
options. Alternatively, you can ask the host to display a native menu at
a specific location.
@tags{Audio}
*/
struct HostProvidedContextMenu
{
@ -54,6 +56,8 @@ struct HostProvidedContextMenu
At the moment, this can be used to retrieve context menus for parameters in
compatible VST3 hosts. Additional extensions may be added here in the future.
@tags{Audio}
*/
struct AudioProcessorEditorHostContext
{

View file

@ -38,6 +38,8 @@ namespace juce
of the function calls that you care about. For example, you should
store the result of VST::getAEffectPtr() rather than storing a pointer
to the VST instance.
@tags{Audio}
*/
struct ExtensionsVisitor
{

View file

@ -56,6 +56,8 @@ enum class MessageBoxIconType
.withAssociatedComponent (myComp),
myCallback);
@endcode
@tags{GUI}
*/
class JUCE_API MessageBoxOptions
{