Skip to content

Commit 301017e

Browse files
pschatzmannpschatzmann
committed
Doxygen
1 parent 525bd69 commit 301017e

33 files changed

+879
-654
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ It can be used as __Arduino library or as regular cmake library__, so you can al
88

99
## Documentation
1010

11-
- [MidiFileParser](https://pschatzmann.github.io/arduino-midi-fileparser/docs/html/classMidiFileParser.html)
11+
- [MidiFileParser](https://pschatzmann.github.io/arduino-midi-fileparser/docs/html/html/group__midifile.html)
1212

1313

1414
## Installation in Arduino

‎docs/html/MidiFileParserOut_8h_source.html‎

Lines changed: 75 additions & 75 deletions
Large diffs are not rendered by default.

‎docs/html/MidiFileParser_8h_source.html‎

Lines changed: 522 additions & 522 deletions
Large diffs are not rendered by default.

‎docs/html/classmidi_1_1MidiFileParser.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
<a href="#pro-attribs">Protected Attributes</a> &#124;
7272
<a href="classmidi_1_1MidiFileParser-members.html">List of all members</a> </div>
7373
<div class="headertitle">
74-
<div class="title">midi::MidiFileParser Class Reference</div> </div>
74+
<div class="title">midi::MidiFileParser Class Reference<div class="ingroups"><a class="el" href="group__midifile.html">Midi File Parser</a></div></div> </div>
7575
</div><!--header-->
7676
<div class="contents">
7777

‎docs/html/classmidi_1_1MidiFileParserOut.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
<a href="#pro-attribs">Protected Attributes</a> &#124;
7272
<a href="classmidi_1_1MidiFileParserOut-members.html">List of all members</a> </div>
7373
<div class="headertitle">
74-
<div class="title">midi::MidiFileParserOut Class Reference</div> </div>
74+
<div class="title">midi::MidiFileParserOut Class Reference<div class="ingroups"><a class="el" href="group__midifile.html">Midi File Parser</a></div></div> </div>
7575
</div><!--header-->
7676
<div class="contents">
7777

‎docs/html/group__midifile.html‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Arduino MIDI File Parser: Midi File Parser</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">Arduino MIDI File Parser
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.9.1 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
36+
/* @license-end */
37+
</script>
38+
<script type="text/javascript" src="menudata.js"></script>
39+
<script type="text/javascript" src="menu.js"></script>
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */</script>
47+
<div id="main-nav"></div>
48+
</div><!-- top -->
49+
<!-- window showing the filter options -->
50+
<div id="MSearchSelectWindow"
51+
onmouseover="return searchBox.OnSearchSelectShow()"
52+
onmouseout="return searchBox.OnSearchSelectHide()"
53+
onkeydown="return searchBox.OnSearchSelectKey(event)">
54+
</div>
55+
56+
<!-- iframe showing the search results (closed by default) -->
57+
<div id="MSearchResultsWindow">
58+
<iframe src="javascript:void(0)" frameborder="0"
59+
name="MSearchResults" id="MSearchResults">
60+
</iframe>
61+
</div>
62+
63+
<div class="header">
64+
<div class="summary">
65+
<a href="#nested-classes">Classes</a> </div>
66+
<div class="headertitle">
67+
<div class="title">Midi File Parser</div> </div>
68+
</div><!--header-->
69+
<div class="contents">
70+
71+
<p>Midi File Parser.
72+
<a href="#details">More...</a></p>
73+
<table class="memberdecls">
74+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
75+
Classes</h2></td></tr>
76+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi_1_1MidiFileParser.html">midi::MidiFileParser</a></td></tr>
77+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Midi File parser. Provide the data via write: You should try to keep the buffer as full as possible while parsing. You get the next parsing result by calling the <a class="el" href="classmidi_1_1MidiFileParser.html#a0c4097975bcf7c4a1d19c377943bf227" title="Parse data in order to provide the next midi element.">parse()</a> method. <a href="classmidi_1_1MidiFileParser.html#details">More...</a><br /></td></tr>
78+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
79+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi_1_1MidiFileParserOut.html">midi::MidiFileParserOut</a></td></tr>
80+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse the <a class="el" href="classmidi_1_1MidiFileParser.html" title="Midi File parser. Provide the data via write: You should try to keep the buffer as full as possible w...">MidiFileParser</a> sending the output to MidiStreamOut. This class requires <a href="https://github.com/pschatzmann/arduino-midi">https://github.com/pschatzmann/arduino-midi</a>. <a href="classmidi_1_1MidiFileParserOut.html#details">More...</a><br /></td></tr>
81+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
82+
</table>
83+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
84+
<p>Midi File Parser. </p>
85+
</div><!-- contents -->
86+
<!-- start footer part -->
87+
<hr class="footer"/><address class="footer"><small>
88+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
89+
</small></address>
90+
</body>
91+
</html>

‎docs/html/menudata.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
*/
2525
var menudata={children:[
2626
{text:"Main Page",url:"index.html"},
27+
{text:"Modules",url:"modules.html"},
2728
{text:"Classes",url:"annotated.html",children:[
2829
{text:"Class List",url:"annotated.html"},
2930
{text:"Class Index",url:"classes.html"},

‎docs/html/modules.html‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Arduino MIDI File Parser: Modules</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">Arduino MIDI File Parser
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.9.1 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
36+
/* @license-end */
37+
</script>
38+
<script type="text/javascript" src="menudata.js"></script>
39+
<script type="text/javascript" src="menu.js"></script>
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */</script>
47+
<div id="main-nav"></div>
48+
</div><!-- top -->
49+
<!-- window showing the filter options -->
50+
<div id="MSearchSelectWindow"
51+
onmouseover="return searchBox.OnSearchSelectShow()"
52+
onmouseout="return searchBox.OnSearchSelectHide()"
53+
onkeydown="return searchBox.OnSearchSelectKey(event)">
54+
</div>
55+
56+
<!-- iframe showing the search results (closed by default) -->
57+
<div id="MSearchResultsWindow">
58+
<iframe src="javascript:void(0)" frameborder="0"
59+
name="MSearchResults" id="MSearchResults">
60+
</iframe>
61+
</div>
62+
63+
<div class="header">
64+
<div class="headertitle">
65+
<div class="title">Modules</div> </div>
66+
</div><!--header-->
67+
<div class="contents">
68+
<div class="textblock">Here is a list of all modules:</div><div class="directory">
69+
<table class="directory">
70+
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a class="el" href="group__midifile.html" target="_self">Midi File Parser</a></td><td class="desc">Midi File Parser </td></tr>
71+
</table>
72+
</div><!-- directory -->
73+
</div><!-- contents -->
74+
<!-- start footer part -->
75+
<hr class="footer"/><address class="footer"><small>
76+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
77+
</small></address>
78+
</body>
79+
</html>

‎docs/html/search/all_4.js‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
var searchData=
22
[
3-
['midi_5ffile_5fformat_5fname_6',['midi_file_format_name',['../classmidi_1_1MidiFileParser.html#a810b3ac596ac34dddc2f63b902e6b3ad',1,'midi::MidiFileParser']]],
4-
['midi_5fheader_7',['midi_header',['../structmidi_1_1midi__header.html',1,'midi']]],
5-
['midi_5fmeta_5fevent_8',['midi_meta_event',['../structmidi_1_1midi__meta__event.html',1,'midi']]],
6-
['midi_5fmeta_5fname_9',['midi_meta_name',['../classmidi_1_1MidiFileParser.html#a2889997844f7c448badf62c33bc5d17e',1,'midi::MidiFileParser']]],
7-
['midi_5fmidi_5fevent_10',['midi_midi_event',['../structmidi_1_1midi__midi__event.html',1,'midi']]],
8-
['midi_5fparser_5fstate_11',['midi_parser_state',['../structmidi_1_1midi__parser__state.html',1,'midi']]],
9-
['midi_5fstatus_5fname_12',['midi_status_name',['../classmidi_1_1MidiFileParser.html#a6a310bc896190fd0166e06e08eea6dd5',1,'midi::MidiFileParser']]],
10-
['midi_5fsysex_5fevent_13',['midi_sysex_event',['../structmidi_1_1midi__sysex__event.html',1,'midi']]],
11-
['midi_5ftrack_14',['midi_track',['../structmidi_1_1midi__track.html',1,'midi']]],
12-
['midifileparser_15',['MidiFileParser',['../classmidi_1_1MidiFileParser.html',1,'midi']]],
13-
['midifileparser_2eh_16',['MidiFileParser.h',['../MidiFileParser_8h.html',1,'']]],
14-
['midifileparserout_17',['MidiFileParserOut',['../classmidi_1_1MidiFileParserOut.html',1,'midi::MidiFileParserOut'],['../classmidi_1_1MidiFileParserOut.html#ab5128a7f1bde4ae083c22fd75f5be627',1,'midi::MidiFileParserOut::MidiFileParserOut()']]]
3+
['midi_20file_20parser_6',['Midi File Parser',['../group__midifile.html',1,'']]],
4+
['midi_5ffile_5fformat_5fname_7',['midi_file_format_name',['../classmidi_1_1MidiFileParser.html#a810b3ac596ac34dddc2f63b902e6b3ad',1,'midi::MidiFileParser']]],
5+
['midi_5fheader_8',['midi_header',['../structmidi_1_1midi__header.html',1,'midi']]],
6+
['midi_5fmeta_5fevent_9',['midi_meta_event',['../structmidi_1_1midi__meta__event.html',1,'midi']]],
7+
['midi_5fmeta_5fname_10',['midi_meta_name',['../classmidi_1_1MidiFileParser.html#a2889997844f7c448badf62c33bc5d17e',1,'midi::MidiFileParser']]],
8+
['midi_5fmidi_5fevent_11',['midi_midi_event',['../structmidi_1_1midi__midi__event.html',1,'midi']]],
9+
['midi_5fparser_5fstate_12',['midi_parser_state',['../structmidi_1_1midi__parser__state.html',1,'midi']]],
10+
['midi_5fstatus_5fname_13',['midi_status_name',['../classmidi_1_1MidiFileParser.html#a6a310bc896190fd0166e06e08eea6dd5',1,'midi::MidiFileParser']]],
11+
['midi_5fsysex_5fevent_14',['midi_sysex_event',['../structmidi_1_1midi__sysex__event.html',1,'midi']]],
12+
['midi_5ftrack_15',['midi_track',['../structmidi_1_1midi__track.html',1,'midi']]],
13+
['midifileparser_16',['MidiFileParser',['../classmidi_1_1MidiFileParser.html',1,'midi']]],
14+
['midifileparser_2eh_17',['MidiFileParser.h',['../MidiFileParser_8h.html',1,'']]],
15+
['midifileparserout_18',['MidiFileParserOut',['../classmidi_1_1MidiFileParserOut.html',1,'midi::MidiFileParserOut'],['../classmidi_1_1MidiFileParserOut.html#ab5128a7f1bde4ae083c22fd75f5be627',1,'midi::MidiFileParserOut::MidiFileParserOut()']]]
1516
];

‎docs/html/search/all_5.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
var searchData=
22
[
3-
['operator_20bool_18',['operator bool',['../classmidi_1_1MidiFileParser.html#a2a6b1adb28b63f814a8f6da60da8cc51',1,'midi::MidiFileParser']]],
4-
['operator_5b_5d_19',['operator[]',['../classmidi_1_1RingBuffer.html#a41bd5105a362763778d0a8e27d3bcf23',1,'midi::RingBuffer']]]
3+
['operator_20bool_19',['operator bool',['../classmidi_1_1MidiFileParser.html#a2a6b1adb28b63f814a8f6da60da8cc51',1,'midi::MidiFileParser']]],
4+
['operator_5b_5d_20',['operator[]',['../classmidi_1_1RingBuffer.html#a41bd5105a362763778d0a8e27d3bcf23',1,'midi::RingBuffer']]]
55
];

0 commit comments

Comments
 (0)