Skip to content

Commit c080f1c

Browse files
pschatzmannpschatzmann
committed
doxygen
1 parent 4c65b4c commit c080f1c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+150
-133
lines changed

‎docs/html/_midi_common_8h_source.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -163,19 +163,18 @@
163163
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; </div>
164164
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmidi_1_1_midi_common.html#afdc7e84bfe245486503768f271680e1f">setMidiAction</a>(<a class="code" href="classmidi_1_1_midi_action.html">MidiAction</a> &amp;<a class="code" href="classmidi_1_1_midi_action.html">MidiAction</a>);</div>
165165
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; </div>
166-
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="comment">// //! Determines the connection status</span></div>
167-
<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>
166+
<div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classmidi_1_1_midi_common.html#abe9bfaacf6e738555f1394ef24fcb200"> 126</a></span>&#160; <span class="keyword">virtual</span> ConnectionStatus <a class="code" href="classmidi_1_1_midi_common.html#abe9bfaacf6e738555f1394ef24fcb200">getConnectionStatus</a>() { <span class="keywordflow">return</span> connectionStatus; }</div>
168167
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; </div>
169168
<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>
170169
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; </div>
171170
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">protected</span>:</div>
172171
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordtype">void</span> setConnectionStatus(ConnectionStatus status) {connectionStatus=status; }</div>
173-
<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>
174-
<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>
172+
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keywordtype">void</span> updateTimestamp(MidiMessage *pMsg);</div>
173+
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> writeData(MidiMessage *msg, <span class="keywordtype">int</span> len);</div>
175174
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; </div>
176175
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; ConnectionStatus connectionStatus;</div>
177-
<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>
178-
<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>
176+
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; MidiAction *pMidiAction;</div>
177+
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; MidiMessage outMessage;</div>
179178
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keywordtype">int</span> receivingChannel = -1; </div>
180179
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; uint8_t sendingChannel = 0; </div>
181180
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; uint8_t timestampLow;</div>
@@ -201,7 +200,8 @@
201200
<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>
202201
<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>
203202
<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>
204-
<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>
203+
<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">write multiple MidiMessage objects to final output</div><div class="ttdef"><b>Definition:</b> MidiCommon.cpp:113</div></div>
204+
<div class="ttc" id="aclassmidi_1_1_midi_common_html_abe9bfaacf6e738555f1394ef24fcb200"><div class="ttname"><a href="classmidi_1_1_midi_common.html#abe9bfaacf6e738555f1394ef24fcb200">midi::MidiCommon::getConnectionStatus</a></div><div class="ttdeci">virtual ConnectionStatus getConnectionStatus()</div><div class="ttdoc">Determines the connection status.</div><div class="ttdef"><b>Definition:</b> MidiCommon.h:126</div></div>
205205
<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>
206206
<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>
207207
<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>

‎docs/html/classmidi_1_1_apple_midi_server-members.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
<tr bgcolor="#f0f0f0"><td class="entry"><b>dns_name</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>
8787
<tr class="even"><td class="entry"><a class="el" href="classmidi_1_1_apple_midi_server.html#a9b495dd596d1aa3f146e07e675c8be4e">end</a>()</td><td class="entry"><a class="el" href="classmidi_1_1_apple_midi_server.html">midi::AppleMidiServer</a></td><td class="entry"></td></tr>
8888
<tr><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html#a3e35624c72c46369acd5eda8e293b056">frequencyToNote</a>(float freq)</td><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html">midi::MidiCommon</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
89-
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>getConnectionStatus</b>() (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">inline</span><span class="mlabel">virtual</span></td></tr>
89+
<tr class="even"><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html#abe9bfaacf6e738555f1394ef24fcb200">getConnectionStatus</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">inline</span><span class="mlabel">virtual</span></td></tr>
9090
<tr bgcolor="#f0f0f0"><td class="entry"><b>is_setup</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>
9191
<tr class="even"><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html#a164dfde583e2e3fdf3e8a277954a3632">localControl</a>(bool active, int8_t channel=-1)</td><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html">midi::MidiCommon</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
9292
<tr><td class="entry"><a class="el" href="classmidi_1_1_apple_midi_server.html#a06c6802d81d37bb6e9770a9939bb42f6">loop</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">inline</span></td></tr>

‎docs/html/classmidi_1_1_apple_midi_server.html‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,8 @@
121121
<tr class="memdesc:a9b495dd596d1aa3f146e07e675c8be4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes the connections. <br /></td></tr>
122122
<tr class="separator:a9b495dd596d1aa3f146e07e675c8be4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
123123
<tr class="memitem:abe9bfaacf6e738555f1394ef24fcb200"><td class="memItemLeft" align="right" valign="top"><a id="abe9bfaacf6e738555f1394ef24fcb200"></a>
124-
virtual ConnectionStatus&#160;</td><td class="memItemRight" valign="bottom"><b>getConnectionStatus</b> ()</td></tr>
124+
virtual ConnectionStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi_1_1_midi_common.html#abe9bfaacf6e738555f1394ef24fcb200">getConnectionStatus</a> ()</td></tr>
125+
<tr class="memdesc:abe9bfaacf6e738555f1394ef24fcb200"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the connection status. <br /></td></tr>
125126
<tr class="separator:abe9bfaacf6e738555f1394ef24fcb200"><td class="memSeparator" colspan="2">&#160;</td></tr>
126127
<tr class="memitem:a164dfde583e2e3fdf3e8a277954a3632"><td class="memItemLeft" align="right" valign="top"><a id="a164dfde583e2e3fdf3e8a277954a3632"></a>
127128
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi_1_1_midi_common.html#a164dfde583e2e3fdf3e8a277954a3632">localControl</a> (bool active, int8_t channel=-1)</td></tr>
@@ -173,7 +174,7 @@
173174
<tr class="separator:aaa7580134db96147cbd55be63d0f2bdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
174175
<tr class="memitem:ab6d5f15c999e24882e9ddade36af1577"><td class="memItemLeft" align="right" valign="top"><a id="ab6d5f15c999e24882e9ddade36af1577"></a>
175176
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>
176-
<tr class="memdesc:ab6d5f15c999e24882e9ddade36af1577"><td class="mdescLeft">&#160;</td><td class="mdescRight">Public proxy method to writeData. <br /></td></tr>
177+
<tr class="memdesc:ab6d5f15c999e24882e9ddade36af1577"><td class="mdescLeft">&#160;</td><td class="mdescRight">write multiple <a class="el" href="structmidi_1_1_midi_message.html" title="The content of the midi message: timestamp, status, arg1 and arg2.">MidiMessage</a> objects to final output <br /></td></tr>
177178
<tr class="separator:ab6d5f15c999e24882e9ddade36af1577"><td class="memSeparator" colspan="2">&#160;</td></tr>
178179
</table><table class="memberdecls">
179180
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>

‎docs/html/classmidi_1_1_midi_ble_client-members.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
<tr><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html#aa80729b4b9932838ddef4fe48242510b">controlChange</a>(uint8_t msg, uint8_t value, int8_t channel=-1)</td><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html">midi::MidiCommon</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
8181
<tr class="even"><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html#a3e35624c72c46369acd5eda8e293b056">frequencyToNote</a>(float freq)</td><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html">midi::MidiCommon</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
8282
<tr><td class="entry"><a class="el" href="classmidi_1_1_midi_ble_client.html#aca50f8ddc38a5939e17db59434d0f485">getBLEAdvertisedDevice</a>()</td><td class="entry"><a class="el" href="classmidi_1_1_midi_ble_client.html">midi::MidiBleClient</a></td><td class="entry"></td></tr>
83-
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>getConnectionStatus</b>() (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">inline</span><span class="mlabel">virtual</span></td></tr>
83+
<tr class="even"><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html#abe9bfaacf6e738555f1394ef24fcb200">getConnectionStatus</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">inline</span><span class="mlabel">virtual</span></td></tr>
8484
<tr><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html#a164dfde583e2e3fdf3e8a277954a3632">localControl</a>(bool active, int8_t channel=-1)</td><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html">midi::MidiCommon</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
8585
<tr class="even"><td class="entry"><a class="el" href="classmidi_1_1_midi_ble_client.html#a84dd40db5d96e88040ecfae823e9c6bf">MidiBleClient</a>(const char *serverName, MidiBleParser *pEventHandler=nullptr)</td><td class="entry"><a class="el" href="classmidi_1_1_midi_ble_client.html">midi::MidiBleClient</a></td><td class="entry"></td></tr>
8686
<tr><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html#a5d28740bb1ff94ae47c41fbf6fa6386f">MidiCommon</a>()</td><td class="entry"><a class="el" href="classmidi_1_1_midi_common.html">midi::MidiCommon</a></td><td class="entry"></td></tr>

‎docs/html/classmidi_1_1_midi_ble_client.html‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,8 @@
121121
<tr class="memdesc:aca50f8ddc38a5939e17db59434d0f485"><td class="mdescLeft">&#160;</td><td class="mdescRight">determe in the BLEAdvertisedDevice <br /></td></tr>
122122
<tr class="separator:aca50f8ddc38a5939e17db59434d0f485"><td class="memSeparator" colspan="2">&#160;</td></tr>
123123
<tr class="memitem:abe9bfaacf6e738555f1394ef24fcb200"><td class="memItemLeft" align="right" valign="top"><a id="abe9bfaacf6e738555f1394ef24fcb200"></a>
124-
virtual ConnectionStatus&#160;</td><td class="memItemRight" valign="bottom"><b>getConnectionStatus</b> ()</td></tr>
124+
virtual ConnectionStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi_1_1_midi_common.html#abe9bfaacf6e738555f1394ef24fcb200">getConnectionStatus</a> ()</td></tr>
125+
<tr class="memdesc:abe9bfaacf6e738555f1394ef24fcb200"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the connection status. <br /></td></tr>
125126
<tr class="separator:abe9bfaacf6e738555f1394ef24fcb200"><td class="memSeparator" colspan="2">&#160;</td></tr>
126127
<tr class="memitem:a164dfde583e2e3fdf3e8a277954a3632"><td class="memItemLeft" align="right" valign="top"><a id="a164dfde583e2e3fdf3e8a277954a3632"></a>
127128
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi_1_1_midi_common.html#a164dfde583e2e3fdf3e8a277954a3632">localControl</a> (bool active, int8_t channel=-1)</td></tr>
@@ -165,7 +166,7 @@
165166
<tr class="separator:afdc7e84bfe245486503768f271680e1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
166167
<tr class="memitem:ab6d5f15c999e24882e9ddade36af1577"><td class="memItemLeft" align="right" valign="top"><a id="ab6d5f15c999e24882e9ddade36af1577"></a>
167168
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>
168-
<tr class="memdesc:ab6d5f15c999e24882e9ddade36af1577"><td class="mdescLeft">&#160;</td><td class="mdescRight">Public proxy method to writeData. <br /></td></tr>
169+
<tr class="memdesc:ab6d5f15c999e24882e9ddade36af1577"><td class="mdescLeft">&#160;</td><td class="mdescRight">write multiple <a class="el" href="structmidi_1_1_midi_message.html" title="The content of the midi message: timestamp, status, arg1 and arg2.">MidiMessage</a> objects to final output <br /></td></tr>
169170
<tr class="separator:ab6d5f15c999e24882e9ddade36af1577"><td class="memSeparator" colspan="2">&#160;</td></tr>
170171
<tr class="memitem:a893c26eb05a3b52e1168d9713bc67096"><td class="memItemLeft" align="right" valign="top"><a id="a893c26eb05a3b52e1168d9713bc67096"></a>
171172
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi_1_1_midi_ble_client.html#a893c26eb05a3b52e1168d9713bc67096">writeData</a> (<a class="el" href="structmidi_1_1_midi_message.html">MidiMessage</a> *pMsg, int len)</td></tr>

0 commit comments

Comments
 (0)