From ab61070933a6ceb7b052e625c69d83628741924a Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Mon, 2 Dec 2024 19:16:23 +0100 Subject: [PATCH] doxygen --- docs/html/_midi_ble_client_8h_source.html | 4 +- docs/html/_midi_common_8h_source.html | 39 ++++++++++--------- docs/html/_midi_parser_8h_source.html | 2 +- ...assmidi_1_1_apple_midi_server-members.html | 3 +- .../html/classmidi_1_1_apple_midi_server.html | 4 ++ ...classmidi_1_1_midi_ble_client-members.html | 3 +- docs/html/classmidi_1_1_midi_ble_client.html | 4 ++ ...classmidi_1_1_midi_ble_parser-members.html | 2 +- ...classmidi_1_1_midi_ble_server-members.html | 3 +- docs/html/classmidi_1_1_midi_ble_server.html | 4 ++ .../classmidi_1_1_midi_common-members.html | 3 +- docs/html/classmidi_1_1_midi_common.html | 4 ++ .../classmidi_1_1_midi_ip_server-members.html | 5 ++- docs/html/classmidi_1_1_midi_ip_server.html | 4 ++ .../classmidi_1_1_midi_parser-members.html | 2 +- .../classmidi_1_1_midi_server-members.html | 3 +- docs/html/classmidi_1_1_midi_server.html | 4 ++ .../classmidi_1_1_midi_stream_in-members.html | 5 ++- docs/html/classmidi_1_1_midi_stream_in.html | 4 ++ ...classmidi_1_1_midi_stream_out-members.html | 3 +- docs/html/classmidi_1_1_midi_stream_out.html | 4 ++ ...classmidi_1_1_midi_udp_server-members.html | 5 ++- docs/html/classmidi_1_1_midi_udp_server.html | 4 ++ docs/html/functions.html | 3 ++ docs/html/functions_func.html | 3 ++ docs/html/index.html | 2 +- docs/html/search/all_e.js | 3 +- docs/html/search/all_f.js | 2 +- docs/html/search/classes_0.js | 2 +- docs/html/search/classes_1.js | 34 ++++++++-------- docs/html/search/functions_0.js | 6 +-- docs/html/search/functions_1.js | 2 +- docs/html/search/functions_2.js | 4 +- docs/html/search/functions_3.js | 2 +- docs/html/search/functions_4.js | 2 +- docs/html/search/functions_5.js | 2 +- docs/html/search/functions_6.js | 4 +- docs/html/search/functions_7.js | 10 ++--- docs/html/search/functions_8.js | 6 +-- docs/html/search/functions_9.js | 4 +- docs/html/search/functions_a.js | 8 ++-- docs/html/search/functions_b.js | 2 +- docs/html/search/functions_c.js | 12 +++--- docs/html/search/functions_d.js | 4 +- docs/html/search/functions_e.js | 3 +- docs/html/search/functions_f.js | 2 +- docs/html/search/pages_0.js | 2 +- 47 files changed, 149 insertions(+), 93 deletions(-) diff --git a/docs/html/_midi_ble_client_8h_source.html b/docs/html/_midi_ble_client_8h_source.html index 01ed31c..2d589d6 100644 --- a/docs/html/_midi_ble_client_8h_source.html +++ b/docs/html/_midi_ble_client_8h_source.html @@ -131,8 +131,8 @@
A Bluetooth Low Energy BLE Client which can send or receive Bluetooth messages. It needs to connect t...
Definition: MidiBleClient.h:22
void begin(MidiAction &MidiAction)
starts the discover and connects if the serverName was found
Definition: MidiBleClient.cpp:16
MidiBleClient(const char *serverName, MidiBleParser *pEventHandler=nullptr)
Default constructor.
Definition: MidiBleClient.cpp:11
-
void writeData(MidiMessage *pMsg, int len)
Processes a message.
Definition: MidiBleClient.cpp:67
-
BLEAdvertisedDevice * getBLEAdvertisedDevice()
determe in the BLEAdvertisedDevice
Definition: MidiBleClient.cpp:86
+
void writeData(MidiMessage *pMsg, int len)
Processes a message.
Definition: MidiBleClient.cpp:71
+
BLEAdvertisedDevice * getBLEAdvertisedDevice()
determe in the BLEAdvertisedDevice
Definition: MidiBleClient.cpp:90
A simple Midi Parser for BLE Midi messages that calls the corresponding events.
Definition: MidiBleParser.h:28
The common methods provided by all Arduino Midi subclasses which can be used to generate Midi message...
Definition: MidiCommon.h:75
The content of the midi message: timestamp, status, arg1 and arg2.
Definition: MidiCommon.h:48
diff --git a/docs/html/_midi_common_8h_source.html b/docs/html/_midi_common_8h_source.html index 746d86b..b13314f 100644 --- a/docs/html/_midi_common_8h_source.html +++ b/docs/html/_midi_common_8h_source.html @@ -166,25 +166,27 @@
125  // //! Determines the connection status
126  virtual ConnectionStatus getConnectionStatus() { return connectionStatus; }
127 
-
128  protected:
-
129  void setConnectionStatus(ConnectionStatus status) {connectionStatus=status; }
-
130  void updateTimestamp(MidiMessage *pMsg);
-
131  virtual void writeData(MidiMessage *msg, int len);
-
132 
-
133  ConnectionStatus connectionStatus;
-
134  MidiAction *pMidiAction;
-
135  MidiMessage outMessage;
-
136  int receivingChannel = -1;
-
137  uint8_t sendingChannel = 0;
-
138  uint8_t timestampLow;
-
139  uint8_t timestampHigh;
-
140  char *name;
-
141 };
-
142 
-
143 
-
144 } // namespace
+
129  void write(MidiMessage *msg, int len);
+
130 
+
131  protected:
+
132  void setConnectionStatus(ConnectionStatus status) {connectionStatus=status; }
+
133  void updateTimestamp(MidiMessage *pMsg);
+
134  virtual void writeData(MidiMessage *msg, int len);
+
135 
+
136  ConnectionStatus connectionStatus;
+
137  MidiAction *pMidiAction;
+
138  MidiMessage outMessage;
+
139  int receivingChannel = -1;
+
140  uint8_t sendingChannel = 0;
+
141  uint8_t timestampLow;
+
142  uint8_t timestampHigh;
+
143  char *name;
+
144 };
145 
-
146 #endif
+
146 
+
147 } // namespace
+
148 
+
149 #endif
Abstract class for a MidiAction.
Definition: MidiAction.h:15
The common methods provided by all Arduino Midi subclasses which can be used to generate Midi message...
Definition: MidiCommon.h:75
virtual void polyPressure(uint8_t valuePar, int8_t channel=-1)
Sends a polyPressure MIDI command to the output.
Definition: MidiCommon.cpp:68
@@ -199,6 +201,7 @@
virtual void noteOn(uint8_t note, uint8_t velocity, int8_t channel=-1)
Sends a noteOn MIDI command to the output.
Definition: MidiCommon.cpp:37
static float noteToFrequency(uint8_t note)
Converts a MIDI note to a frequency in Hz.
Definition: MidiCommon.cpp:101
virtual void controlChange(uint8_t msg, uint8_t value, int8_t channel=-1)
Sends a control change MIDI command to the output.
Definition: MidiCommon.cpp:94
+
void write(MidiMessage *msg, int len)
Public proxy method to writeData.
Definition: MidiCommon.cpp:113
virtual void pitchBend(uint16_t value, int8_t channel=-1)
Sends a pitchBend MIDI command to the output.
Definition: MidiCommon.cpp:53
virtual void allNotesOff(int8_t channel=-1)
Sends a allNotesOff MIDI command to the output.
Definition: MidiCommon.cpp:82
virtual void programChange(uint8_t program, int8_t channel=-1)
Sends a programChange MIDI command to the output.
Definition: MidiCommon.cpp:75
diff --git a/docs/html/_midi_parser_8h_source.html b/docs/html/_midi_parser_8h_source.html index 9b0310e..20a77b4 100644 --- a/docs/html/_midi_parser_8h_source.html +++ b/docs/html/_midi_parser_8h_source.html @@ -85,7 +85,7 @@
30  public:
31  MidiParser() = default;
32  MidiParser(MidiAction *MidiAction, int filter_channel = -1 );
-
33  ~MidiParser();
+
33  virtual ~MidiParser();
34 
36  void begin(MidiAction *MidiAction, int filter_channel = -1 );
37 
diff --git a/docs/html/classmidi_1_1_apple_midi_server-members.html b/docs/html/classmidi_1_1_apple_midi_server-members.html index fa3dcad..76f34c8 100644 --- a/docs/html/classmidi_1_1_apple_midi_server-members.html +++ b/docs/html/classmidi_1_1_apple_midi_server-members.html @@ -119,7 +119,8 @@ udpControl (defined in midi::AppleMidiServer)midi::AppleMidiServerprotected udpData (defined in midi::AppleMidiServer)midi::AppleMidiServerprotected updateTimestamp(MidiMessage *pMsg) (defined in midi::MidiCommon)midi::MidiCommonprotected - writeData(MidiMessage *msg, int len)midi::AppleMidiServerprotectedvirtual + write(MidiMessage *msg, int len)midi::MidiCommon + writeData(MidiMessage *msg, int len)midi::AppleMidiServerprotectedvirtual