Skip to content
This repository was archived by the owner on Feb 25, 2024. It is now read-only.

Commit 90483c7

Browse files
committed
Updated JavaDocs
1 parent 5092373 commit 90483c7

90 files changed

Lines changed: 44671 additions & 2857 deletions

File tree

Some content is hidden

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

docs/allclasses-frame.html

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/allclasses-index.html

Lines changed: 278 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,278 @@
1+
<!DOCTYPE HTML>
2+
<!-- NewPage -->
3+
<html lang="de">
4+
<head>
5+
<!-- Generated by javadoc (11.0.1) on Mon Jan 14 13:52:41 CET 2019 -->
6+
<title>All Classes (vban-api 0.3.0-SNAPSHOT API)</title>
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2019-01-14">
9+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
10+
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
11+
<script type="text/javascript" src="script.js"></script>
12+
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
13+
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
14+
<!--[if IE]>
15+
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
16+
<![endif]-->
17+
<script type="text/javascript" src="jquery/jquery-3.3.1.js"></script>
18+
<script type="text/javascript" src="jquery/jquery-migrate-3.0.1.js"></script>
19+
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
20+
</head>
21+
<body>
22+
<script type="text/javascript"><!--
23+
try {
24+
if (location.href.indexOf('is-external=true') == -1) {
25+
parent.document.title="All Classes (vban-api 0.3.0-SNAPSHOT API)";
26+
}
27+
}
28+
catch(err) {
29+
}
30+
//-->
31+
var data = {"i0":1,"i1":1,"i2":1,"i3":1,"i4":1,"i5":1,"i6":1,"i7":1,"i8":2,"i9":2,"i10":4,"i11":4,"i12":4,"i13":2,"i14":4,"i15":2,"i16":2,"i17":2,"i18":2,"i19":2,"i20":2};
32+
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"]};
33+
var altColor = "altColor";
34+
var rowColor = "rowColor";
35+
var tableTab = "tableTab";
36+
var activeTableTab = "activeTableTab";
37+
var pathtoroot = "./";
38+
var useModuleDirectories = true;
39+
loadScripts(document, 'script');</script>
40+
<noscript>
41+
<div>JavaScript is disabled on your browser.</div>
42+
</noscript>
43+
<header role="banner">
44+
<nav role="navigation">
45+
<div class="fixedNav">
46+
<!-- ========= START OF TOP NAVBAR ======= -->
47+
<div class="topNav"><a id="navbar.top">
48+
<!-- -->
49+
</a>
50+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
51+
<a id="navbar.top.firstrow">
52+
<!-- -->
53+
</a>
54+
<ul class="navList" title="Navigation">
55+
<li><a href="index.html">Overview</a></li>
56+
<li>Package</li>
57+
<li>Class</li>
58+
<li><a href="overview-tree.html">Tree</a></li>
59+
<li><a href="deprecated-list.html">Deprecated</a></li>
60+
<li><a href="index-all.html">Index</a></li>
61+
<li><a href="help-doc.html">Help</a></li>
62+
</ul>
63+
</div>
64+
<div class="subNav">
65+
<ul class="navList" id="allclasses_navbar_top">
66+
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
67+
</ul>
68+
<ul class="navListSearch">
69+
<li><label for="search">SEARCH:</label>
70+
<input type="text" id="search" value="search" disabled="disabled">
71+
<input type="reset" id="reset" value="reset" disabled="disabled">
72+
</li>
73+
</ul>
74+
<div>
75+
<script type="text/javascript"><!--
76+
allClassesLink = document.getElementById("allclasses_navbar_top");
77+
if(window==top) {
78+
allClassesLink.style.display = "block";
79+
}
80+
else {
81+
allClassesLink.style.display = "none";
82+
}
83+
//-->
84+
</script>
85+
<noscript>
86+
<div>JavaScript is disabled on your browser.</div>
87+
</noscript>
88+
</div>
89+
<a id="skip.navbar.top">
90+
<!-- -->
91+
</a></div>
92+
<!-- ========= END OF TOP NAVBAR ========= -->
93+
</div>
94+
<div class="navPadding">&nbsp;</div>
95+
<script type="text/javascript"><!--
96+
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
97+
//-->
98+
</script>
99+
</nav>
100+
</header>
101+
<main role="main">
102+
<div class="header">
103+
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
104+
</div>
105+
<div class="allClassesContainer">
106+
<ul class="blockList">
107+
<li class="blockList">
108+
<table class="typeSummary">
109+
<caption><span id="t0" class="activeTableTab"><span>All Classes</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Interface Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Class Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Enum Summary</a></span><span class="tabEnd">&nbsp;</span></span></caption>
110+
<tr>
111+
<th class="colFirst" scope="col">Class</th>
112+
<th class="colLast" scope="col">Description</th>
113+
</tr>
114+
<tr id="i0" class="altColor">
115+
<td class="colFirst"><a href="de/kaleidox/vban/model/AudioPacket.html" title="interface in de.kaleidox.vban.model">AudioPacket</a></td>
116+
<th class="colLast" scope="row">
117+
<div class="block"><s>Preliminary</s> interface for packets containing audio data.</div>
118+
</th>
119+
</tr>
120+
<tr id="i1" class="rowColor">
121+
<td class="colFirst"><a href="de/kaleidox/util/model/Bindable.html" title="interface in de.kaleidox.util.model">Bindable</a>&lt;<a href="de/kaleidox/util/model/Bindable.html" title="type parameter in Bindable">Target</a>&gt;</td>
122+
<th class="colLast" scope="row">
123+
<div class="block">Interface for binding a parameter with a type-variable.</div>
124+
</th>
125+
</tr>
126+
<tr id="i2" class="altColor">
127+
<td class="colFirst"><a href="de/kaleidox/util/model/Builder.html" title="interface in de.kaleidox.util.model">Builder</a>&lt;<a href="de/kaleidox/util/model/Builder.html" title="type parameter in Builder">T</a>&gt;</td>
128+
<th class="colLast" scope="row">
129+
<div class="block">A Builder is used to create one instance of <code>T</code> with different parameters.</div>
130+
</th>
131+
</tr>
132+
<tr id="i3" class="rowColor">
133+
<td class="colFirst"><a href="de/kaleidox/util/model/ByteArray.html" title="interface in de.kaleidox.util.model">ByteArray</a></td>
134+
<th class="colLast" scope="row">
135+
<div class="block">Marks an object as a carrier for an array of bytes.</div>
136+
</th>
137+
</tr>
138+
<tr id="i4" class="altColor">
139+
<td class="colFirst"><a href="de/kaleidox/util/model/Factory.html" title="interface in de.kaleidox.util.model">Factory</a>&lt;<a href="de/kaleidox/util/model/Factory.html" title="type parameter in Factory">T</a>&gt;</td>
140+
<th class="colLast" scope="row">
141+
<div class="block">A Factory creates more instances of <code>T</code> with an internal counter
142+
whose value can be acquired with <a href="de/kaleidox/util/model/Factory.html#counter()"><code>Factory.counter()</code></a>.</div>
143+
</th>
144+
</tr>
145+
<tr id="i5" class="rowColor">
146+
<td class="colFirst"><a href="de/kaleidox/vban/model/FormatValue.html" title="interface in de.kaleidox.vban.model">FormatValue</a>&lt;<a href="de/kaleidox/vban/model/FormatValue.html" title="type parameter in FormatValue">T</a>&gt;</td>
147+
<th class="colLast" scope="row">
148+
<div class="block">Bindable and IntEnum interface for the value that belongs into the format-bit of a packetheader.</div>
149+
</th>
150+
</tr>
151+
<tr id="i6" class="altColor">
152+
<td class="colFirst"><a href="de/kaleidox/util/model/IntEnum.html" title="interface in de.kaleidox.util.model">IntEnum</a></td>
153+
<th class="colLast" scope="row">
154+
<div class="block">Interface marking an <code>Enum</code> as a carrier for an <code>int</code> value.</div>
155+
</th>
156+
</tr>
157+
<tr id="i7" class="rowColor">
158+
<td class="colFirst"><a href="de/kaleidox/vban/model/SRValue.html" title="interface in de.kaleidox.vban.model">SRValue</a>&lt;<a href="de/kaleidox/vban/model/SRValue.html" title="type parameter in SRValue">T</a>&gt;</td>
159+
<th class="colLast" scope="row">
160+
<div class="block">Bindable and IntEnum interface for the value that belongs into the sr-bit of a packetheader.</div>
161+
</th>
162+
</tr>
163+
<tr id="i8" class="altColor">
164+
<td class="colFirst"><a href="de/kaleidox/vban/Util.html" title="class in de.kaleidox.vban">Util</a></td>
165+
<th class="colLast" scope="row">
166+
<div class="block">Collection of Utility methods for the VBAN API.</div>
167+
</th>
168+
</tr>
169+
<tr id="i9" class="rowColor">
170+
<td class="colFirst"><a href="de/kaleidox/vban/VBAN.html" title="class in de.kaleidox.vban">VBAN</a>&lt;<a href="de/kaleidox/vban/VBAN.html" title="type parameter in VBAN">D</a>&gt;</td>
171+
<th class="colLast" scope="row">
172+
<div class="block">Facade class for interacting with the API.</div>
173+
</th>
174+
</tr>
175+
<tr id="i10" class="altColor">
176+
<td class="colFirst"><a href="de/kaleidox/vban/VBAN.AudioFormat.html" title="enum in de.kaleidox.vban">VBAN.AudioFormat</a></td>
177+
<th class="colLast" scope="row">
178+
<div class="block">Collection of format values, required for creating a <a href="de/kaleidox/vban/packet/VBANPacketHead.Factory.html" title="class in de.kaleidox.vban.packet"><code>VBANPacketHead.Factory</code></a>.</div>
179+
</th>
180+
</tr>
181+
<tr id="i11" class="rowColor">
182+
<td class="colFirst"><a href="de/kaleidox/vban/VBAN.BitsPerSecond.html" title="enum in de.kaleidox.vban">VBAN.BitsPerSecond</a></td>
183+
<th class="colLast" scope="row">&nbsp;</th>
184+
</tr>
185+
<tr id="i12" class="altColor">
186+
<td class="colFirst"><a href="de/kaleidox/vban/VBAN.Format.html" title="enum in de.kaleidox.vban">VBAN.Format</a></td>
187+
<th class="colLast" scope="row">&nbsp;</th>
188+
</tr>
189+
<tr id="i13" class="rowColor">
190+
<td class="colFirst"><a href="de/kaleidox/vban/VBAN.Protocol.html" title="class in de.kaleidox.vban">VBAN.Protocol</a>&lt;<a href="de/kaleidox/vban/VBAN.Protocol.html" title="type parameter in VBAN.Protocol">T</a>&gt;</td>
191+
<th class="colLast" scope="row">
192+
<div class="block">Collection of protocol values, required for creating a <a href="de/kaleidox/vban/packet/VBANPacketHead.Factory.html" title="class in de.kaleidox.vban.packet"><code>VBANPacketHead.Factory</code></a>.</div>
193+
</th>
194+
</tr>
195+
<tr id="i14" class="altColor">
196+
<td class="colFirst"><a href="de/kaleidox/vban/VBAN.SampleRate.html" title="enum in de.kaleidox.vban">VBAN.SampleRate</a></td>
197+
<th class="colLast" scope="row">
198+
<div class="block">Collection of sample rate indices, required for creating a <a href="de/kaleidox/vban/packet/VBANPacketHead.Factory.html" title="class in de.kaleidox.vban.packet"><code>VBANPacketHead.Factory</code></a>.</div>
199+
</th>
200+
</tr>
201+
<tr id="i15" class="rowColor">
202+
<td class="colFirst"><a href="de/kaleidox/vban/packet/VBANPacket.html" title="class in de.kaleidox.vban.packet">VBANPacket</a>&lt;<a href="de/kaleidox/vban/packet/VBANPacket.html" title="type parameter in VBANPacket">T</a>&gt;</td>
203+
<th class="colLast" scope="row">
204+
<div class="block">Structural object representation of a VBAN UDP Packet.</div>
205+
</th>
206+
</tr>
207+
<tr id="i16" class="altColor">
208+
<td class="colFirst"><a href="de/kaleidox/vban/packet/VBANPacket.Factory.html" title="class in de.kaleidox.vban.packet">VBANPacket.Factory</a>&lt;<a href="de/kaleidox/vban/packet/VBANPacket.Factory.html" title="type parameter in VBANPacket.Factory">T</a>&gt;</td>
209+
<th class="colLast" scope="row">&nbsp;</th>
210+
</tr>
211+
<tr id="i17" class="rowColor">
212+
<td class="colFirst"><a href="de/kaleidox/vban/packet/VBANPacket.Factory.Builder.html" title="class in de.kaleidox.vban.packet">VBANPacket.Factory.Builder</a>&lt;<a href="de/kaleidox/vban/packet/VBANPacket.Factory.Builder.html" title="type parameter in VBANPacket.Factory.Builder">T</a>&gt;</td>
213+
<th class="colLast" scope="row">&nbsp;</th>
214+
</tr>
215+
<tr id="i18" class="altColor">
216+
<td class="colFirst"><a href="de/kaleidox/vban/packet/VBANPacketHead.html" title="class in de.kaleidox.vban.packet">VBANPacketHead</a>&lt;<a href="de/kaleidox/vban/packet/VBANPacketHead.html" title="type parameter in VBANPacketHead">T</a>&gt;</td>
217+
<th class="colLast" scope="row">&nbsp;</th>
218+
</tr>
219+
<tr id="i19" class="rowColor">
220+
<td class="colFirst"><a href="de/kaleidox/vban/packet/VBANPacketHead.Factory.html" title="class in de.kaleidox.vban.packet">VBANPacketHead.Factory</a>&lt;<a href="de/kaleidox/vban/packet/VBANPacketHead.Factory.html" title="type parameter in VBANPacketHead.Factory">T</a>&gt;</td>
221+
<th class="colLast" scope="row">&nbsp;</th>
222+
</tr>
223+
<tr id="i20" class="altColor">
224+
<td class="colFirst"><a href="de/kaleidox/vban/packet/VBANPacketHead.Factory.Builder.html" title="class in de.kaleidox.vban.packet">VBANPacketHead.Factory.Builder</a>&lt;<a href="de/kaleidox/vban/packet/VBANPacketHead.Factory.Builder.html" title="type parameter in VBANPacketHead.Factory.Builder">T</a>&gt;</td>
225+
<th class="colLast" scope="row">&nbsp;</th>
226+
</tr>
227+
</table>
228+
</li>
229+
</ul>
230+
</div>
231+
</main>
232+
<footer role="contentinfo">
233+
<nav role="navigation">
234+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
235+
<div class="bottomNav"><a id="navbar.bottom">
236+
<!-- -->
237+
</a>
238+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
239+
<a id="navbar.bottom.firstrow">
240+
<!-- -->
241+
</a>
242+
<ul class="navList" title="Navigation">
243+
<li><a href="index.html">Overview</a></li>
244+
<li>Package</li>
245+
<li>Class</li>
246+
<li><a href="overview-tree.html">Tree</a></li>
247+
<li><a href="deprecated-list.html">Deprecated</a></li>
248+
<li><a href="index-all.html">Index</a></li>
249+
<li><a href="help-doc.html">Help</a></li>
250+
</ul>
251+
</div>
252+
<div class="subNav">
253+
<ul class="navList" id="allclasses_navbar_bottom">
254+
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
255+
</ul>
256+
<div>
257+
<script type="text/javascript"><!--
258+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
259+
if(window==top) {
260+
allClassesLink.style.display = "block";
261+
}
262+
else {
263+
allClassesLink.style.display = "none";
264+
}
265+
//-->
266+
</script>
267+
<noscript>
268+
<div>JavaScript is disabled on your browser.</div>
269+
</noscript>
270+
</div>
271+
<a id="skip.navbar.bottom">
272+
<!-- -->
273+
</a></div>
274+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
275+
</nav>
276+
</footer>
277+
</body>
278+
</html>

docs/allclasses-noframe.html

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)