Skip to content

Commit

Permalink
doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
@pschatzmann
pschatzmann committed Dec 2, 2024
1 parent f2826af commit ab61070
Show file tree
Hide file tree
Showing 47 changed files with 149 additions and 93 deletions.
4 changes: 2 additions & 2 deletions docs/html/_midi_ble_client_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,8 @@
<div class="ttc" id="aclassmidi_1_1_midi_ble_client_html"><div class="ttname"><a href="classmidi_1_1_midi_ble_client.html">midi::MidiBleClient</a></div><div class="ttdoc">A Bluetooth Low Energy BLE Client which can send or receive Bluetooth messages. It needs to connect t...</div><div class="ttdef"><b>Definition:</b> MidiBleClient.h:22</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_ble_client_html_a149d7fcadf59b4fc97fb5497126866d1"><div class="ttname"><a href="classmidi_1_1_midi_ble_client.html#a149d7fcadf59b4fc97fb5497126866d1">midi::MidiBleClient::begin</a></div><div class="ttdeci">void begin(MidiAction &amp;MidiAction)</div><div class="ttdoc">starts the discover and connects if the serverName was found</div><div class="ttdef"><b>Definition:</b> MidiBleClient.cpp:16</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_ble_client_html_a84dd40db5d96e88040ecfae823e9c6bf"><div class="ttname"><a href="classmidi_1_1_midi_ble_client.html#a84dd40db5d96e88040ecfae823e9c6bf">midi::MidiBleClient::MidiBleClient</a></div><div class="ttdeci">MidiBleClient(const char *serverName, MidiBleParser *pEventHandler=nullptr)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> MidiBleClient.cpp:11</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_ble_client_html_a893c26eb05a3b52e1168d9713bc67096"><div class="ttname"><a href="classmidi_1_1_midi_ble_client.html#a893c26eb05a3b52e1168d9713bc67096">midi::MidiBleClient::writeData</a></div><div class="ttdeci">void writeData(MidiMessage *pMsg, int len)</div><div class="ttdoc">Processes a message.</div><div class="ttdef"><b>Definition:</b> MidiBleClient.cpp:67</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_ble_client_html_aca50f8ddc38a5939e17db59434d0f485"><div class="ttname"><a href="classmidi_1_1_midi_ble_client.html#aca50f8ddc38a5939e17db59434d0f485">midi::MidiBleClient::getBLEAdvertisedDevice</a></div><div class="ttdeci">BLEAdvertisedDevice * getBLEAdvertisedDevice()</div><div class="ttdoc">determe in the BLEAdvertisedDevice</div><div class="ttdef"><b>Definition:</b> MidiBleClient.cpp:86</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_ble_client_html_a893c26eb05a3b52e1168d9713bc67096"><div class="ttname"><a href="classmidi_1_1_midi_ble_client.html#a893c26eb05a3b52e1168d9713bc67096">midi::MidiBleClient::writeData</a></div><div class="ttdeci">void writeData(MidiMessage *pMsg, int len)</div><div class="ttdoc">Processes a message.</div><div class="ttdef"><b>Definition:</b> MidiBleClient.cpp:71</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_ble_client_html_aca50f8ddc38a5939e17db59434d0f485"><div class="ttname"><a href="classmidi_1_1_midi_ble_client.html#aca50f8ddc38a5939e17db59434d0f485">midi::MidiBleClient::getBLEAdvertisedDevice</a></div><div class="ttdeci">BLEAdvertisedDevice * getBLEAdvertisedDevice()</div><div class="ttdoc">determe in the BLEAdvertisedDevice</div><div class="ttdef"><b>Definition:</b> MidiBleClient.cpp:90</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_ble_parser_html"><div class="ttname"><a href="classmidi_1_1_midi_ble_parser.html">midi::MidiBleParser</a></div><div class="ttdoc">A simple Midi Parser for BLE Midi messages that calls the corresponding events.</div><div class="ttdef"><b>Definition:</b> MidiBleParser.h:28</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_common_html"><div class="ttname"><a href="classmidi_1_1_midi_common.html">midi::MidiCommon</a></div><div class="ttdoc">The common methods provided by all Arduino Midi subclasses which can be used to generate Midi message...</div><div class="ttdef"><b>Definition:</b> MidiCommon.h:75</div></div>
<div class="ttc" id="astructmidi_1_1_midi_message_html"><div class="ttname"><a href="structmidi_1_1_midi_message.html">midi::MidiMessage</a></div><div class="ttdoc">The content of the midi message: timestamp, status, arg1 and arg2.</div><div class="ttdef"><b>Definition:</b> MidiCommon.h:48</div></div>
Expand Down
39 changes: 21 additions & 18 deletions docs/html/_midi_common_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,25 +166,27 @@
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="comment">// //! Determines the connection status</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keyword">virtual</span> ConnectionStatus getConnectionStatus() { <span class="keywordflow">return</span> connectionStatus; }</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keywordtype">void</span> setConnectionStatus(ConnectionStatus status) {connectionStatus=status; }</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keywordtype">void</span> updateTimestamp(<a class="code" href="structmidi_1_1_midi_message.html">MidiMessage</a> *pMsg);</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> writeData(<a class="code" href="structmidi_1_1_midi_message.html">MidiMessage</a> *msg, <span class="keywordtype">int</span> len);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; ConnectionStatus connectionStatus;</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <a class="code" href="classmidi_1_1_midi_action.html">MidiAction</a> *pMidiAction;</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <a class="code" href="structmidi_1_1_midi_message.html">MidiMessage</a> outMessage;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keywordtype">int</span> receivingChannel = -1; </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; uint8_t sendingChannel = 0; </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; uint8_t timestampLow;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; uint8_t timestampHigh;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keywordtype">char</span> *name;</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;};</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;} <span class="comment">// namespace</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmidi_1_1_midi_common.html#ab6d5f15c999e24882e9ddade36af1577">write</a>(<a class="code" href="structmidi_1_1_midi_message.html">MidiMessage</a> *msg, <span class="keywordtype">int</span> len);</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordtype">void</span> setConnectionStatus(ConnectionStatus status) {connectionStatus=status; }</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keywordtype">void</span> updateTimestamp(<a class="code" href="structmidi_1_1_midi_message.html">MidiMessage</a> *pMsg);</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> writeData(<a class="code" href="structmidi_1_1_midi_message.html">MidiMessage</a> *msg, <span class="keywordtype">int</span> len);</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; </div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; ConnectionStatus connectionStatus;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <a class="code" href="classmidi_1_1_midi_action.html">MidiAction</a> *pMidiAction;</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <a class="code" href="structmidi_1_1_midi_message.html">MidiMessage</a> outMessage;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keywordtype">int</span> receivingChannel = -1; </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; uint8_t sendingChannel = 0; </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; uint8_t timestampLow;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; uint8_t timestampHigh;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keywordtype">char</span> *name;</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;};</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;} <span class="comment">// namespace</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; </div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassmidi_1_1_midi_action_html"><div class="ttname"><a href="classmidi_1_1_midi_action.html">midi::MidiAction</a></div><div class="ttdoc">Abstract class for a MidiAction.</div><div class="ttdef"><b>Definition:</b> MidiAction.h:15</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_common_html"><div class="ttname"><a href="classmidi_1_1_midi_common.html">midi::MidiCommon</a></div><div class="ttdoc">The common methods provided by all Arduino Midi subclasses which can be used to generate Midi message...</div><div class="ttdef"><b>Definition:</b> MidiCommon.h:75</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_common_html_a00771509caca2e46fb273b1ae8178517"><div class="ttname"><a href="classmidi_1_1_midi_common.html#a00771509caca2e46fb273b1ae8178517">midi::MidiCommon::polyPressure</a></div><div class="ttdeci">virtual void polyPressure(uint8_t valuePar, int8_t channel=-1)</div><div class="ttdoc">Sends a polyPressure MIDI command to the output.</div><div class="ttdef"><b>Definition:</b> MidiCommon.cpp:68</div></div>
Expand All @@ -199,6 +201,7 @@
<div class="ttc" id="aclassmidi_1_1_midi_common_html_a7e026258c4355d38dedda82f1862141c"><div class="ttname"><a href="classmidi_1_1_midi_common.html#a7e026258c4355d38dedda82f1862141c">midi::MidiCommon::noteOn</a></div><div class="ttdeci">virtual void noteOn(uint8_t note, uint8_t velocity, int8_t channel=-1)</div><div class="ttdoc">Sends a noteOn MIDI command to the output.</div><div class="ttdef"><b>Definition:</b> MidiCommon.cpp:37</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_common_html_a95a089c4af7d0809094255de9a4bf242"><div class="ttname"><a href="classmidi_1_1_midi_common.html#a95a089c4af7d0809094255de9a4bf242">midi::MidiCommon::noteToFrequency</a></div><div class="ttdeci">static float noteToFrequency(uint8_t note)</div><div class="ttdoc">Converts a MIDI note to a frequency in Hz.</div><div class="ttdef"><b>Definition:</b> MidiCommon.cpp:101</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_common_html_aa80729b4b9932838ddef4fe48242510b"><div class="ttname"><a href="classmidi_1_1_midi_common.html#aa80729b4b9932838ddef4fe48242510b">midi::MidiCommon::controlChange</a></div><div class="ttdeci">virtual void controlChange(uint8_t msg, uint8_t value, int8_t channel=-1)</div><div class="ttdoc">Sends a control change MIDI command to the output.</div><div class="ttdef"><b>Definition:</b> MidiCommon.cpp:94</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_common_html_ab6d5f15c999e24882e9ddade36af1577"><div class="ttname"><a href="classmidi_1_1_midi_common.html#ab6d5f15c999e24882e9ddade36af1577">midi::MidiCommon::write</a></div><div class="ttdeci">void write(MidiMessage *msg, int len)</div><div class="ttdoc">Public proxy method to writeData.</div><div class="ttdef"><b>Definition:</b> MidiCommon.cpp:113</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_common_html_ac1ef192cf2b1adfcc89d4cf3db5e80a3"><div class="ttname"><a href="classmidi_1_1_midi_common.html#ac1ef192cf2b1adfcc89d4cf3db5e80a3">midi::MidiCommon::pitchBend</a></div><div class="ttdeci">virtual void pitchBend(uint16_t value, int8_t channel=-1)</div><div class="ttdoc">Sends a pitchBend MIDI command to the output.</div><div class="ttdef"><b>Definition:</b> MidiCommon.cpp:53</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_common_html_ae14155807a18449e6c3a2117b99aef82"><div class="ttname"><a href="classmidi_1_1_midi_common.html#ae14155807a18449e6c3a2117b99aef82">midi::MidiCommon::allNotesOff</a></div><div class="ttdeci">virtual void allNotesOff(int8_t channel=-1)</div><div class="ttdoc">Sends a allNotesOff MIDI command to the output.</div><div class="ttdef"><b>Definition:</b> MidiCommon.cpp:82</div></div>
<div class="ttc" id="aclassmidi_1_1_midi_common_html_aee00ffec71667ca134c697a115e649f9"><div class="ttname"><a href="classmidi_1_1_midi_common.html#aee00ffec71667ca134c697a115e649f9">midi::MidiCommon::programChange</a></div><div class="ttdeci">virtual void programChange(uint8_t program, int8_t channel=-1)</div><div class="ttdoc">Sends a programChange MIDI command to the output.</div><div class="ttdef"><b>Definition:</b> MidiCommon.cpp:75</div></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_midi_parser_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="classmidi_1_1_midi_parser.html">MidiParser</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classmidi_1_1_midi_parser.html">MidiParser</a>(<a class="code" href="classmidi_1_1_midi_action.html">MidiAction</a> *<a class="code" href="classmidi_1_1_midi_action.html">MidiAction</a>, <span class="keywordtype">int</span> filter_channel = -1 );</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; ~<a class="code" href="classmidi_1_1_midi_parser.html">MidiParser</a>();</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classmidi_1_1_midi_parser.html">MidiParser</a>();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmidi_1_1_midi_parser.html#a9db739297e9dba37b5e814da6f079b42">begin</a>(<a class="code" href="classmidi_1_1_midi_action.html">MidiAction</a> *<a class="code" href="classmidi_1_1_midi_action.html">MidiAction</a>, <span class="keywordtype">int</span> filter_channel = -1 );</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/classmidi_1_1_apple_midi_server-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,8 @@
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>udpControl</b> (defined in <a class="el" href="classmidi_1_1_apple_midi_server.html">midi::AppleMidiServer</a>)</td><td class="entry"><a class="el" href="classmidi_1_1_apple_midi_server.html">midi::AppleMidiServer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>udpData</b> (defined in <a class="el" href="classmidi_1_1_apple_midi_server.html">midi::AppleMidiServer</a>)</td><td class="entry"><a class="el" href="classmidi_1_1_apple_midi_server.html">midi::AppleMidiServer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>updateTimestamp</b>(MidiMessage *pMsg) (defined in <a class="el" href="classmidi_1_1_midi_common.html">midi::MidiCommon</a>)</td><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html">midi::MidiCommon</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classmidi_1_1_apple_midi_server.html#ae997b18aaa2f74298cf659de9defd553">writeData</a>(MidiMessage *msg, int len)</td><td class="entry"><a class="el" href="classmidi_1_1_apple_midi_server.html">midi::AppleMidiServer</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html#ab6d5f15c999e24882e9ddade36af1577">write</a>(MidiMessage *msg, int len)</td><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html">midi::MidiCommon</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classmidi_1_1_apple_midi_server.html#ae997b18aaa2f74298cf659de9defd553">writeData</a>(MidiMessage *msg, int len)</td><td class="entry"><a class="el" href="classmidi_1_1_apple_midi_server.html">midi::AppleMidiServer</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
4 changes: 4 additions & 0 deletions docs/html/classmidi_1_1_apple_midi_server.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,10 @@
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi_1_1_apple_midi_server.html#aaa7580134db96147cbd55be63d0f2bdc">setName</a> (const char *name)</td></tr>
<tr class="memdesc:aaa7580134db96147cbd55be63d0f2bdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the dns name. <br /></td></tr>
<tr class="separator:aaa7580134db96147cbd55be63d0f2bdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6d5f15c999e24882e9ddade36af1577"><td class="memItemLeft" align="right" valign="top"><a id="ab6d5f15c999e24882e9ddade36af1577"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi_1_1_midi_common.html#ab6d5f15c999e24882e9ddade36af1577">write</a> (<a class="el" href="structmidi_1_1_midi_message.html">MidiMessage</a> *msg, int len)</td></tr>
<tr class="memdesc:ab6d5f15c999e24882e9ddade36af1577"><td class="mdescLeft">&#160;</td><td class="mdescRight">Public proxy method to writeData. <br /></td></tr>
<tr class="separator:ab6d5f15c999e24882e9ddade36af1577"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
Expand Down
Loading

0 comments on commit ab61070

Please sign in to comment.