Skip to content

Commit

Permalink
Updated javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
@weliem
weliem committed Jun 24, 2021
1 parent f7f60ca commit 300901e
Show file tree
Hide file tree
Showing 89 changed files with 38,430 additions and 184 deletions.
38 changes: 0 additions & 38 deletions docs/allclasses-frame.html
View file

This file was deleted.

279 changes: 279 additions & 0 deletions docs/allclasses-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,279 @@
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.8) on Thu Jun 24 22:56:15 CEST 2021 -->
<title>All Classes</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2021-06-24">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="All Classes";
}
}
catch(err) {
}
//-->
var data = {"i0":4,"i1":2,"i2":2,"i3":2,"i4":2,"i5":2,"i6":2,"i7":2,"i8":2,"i9":4,"i10":4,"i11":4,"i12":4,"i13":4,"i14":4,"i15":4,"i16":4,"i17":4,"i18":4,"i19":4};
var tabs = {65535:["t0","All Classes"],2:["t2","Class Summary"],4:["t3","Enum Summary"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "./";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="com/welie/blessed/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-files/index-1.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</div>
<div class="allClassesContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span id="t0" class="activeTableTab"><span>All Classes</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>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><a href="com/welie/blessed/AdvertiseError.html" title="enum in com.welie.blessed">AdvertiseError</a></td>
<th class="colLast" scope="row">
<div class="block">This enum describes all possible errors that can occur when trying to start advertising</div>
</th>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><a href="com/welie/blessed/BluetoothBytesParser.html" title="class in com.welie.blessed">BluetoothBytesParser</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><a href="com/welie/blessed/BluetoothCentral.html" title="class in com.welie.blessed">BluetoothCentral</a></td>
<th class="colLast" scope="row">
<div class="block">This class represent a remote Central</div>
</th>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><a href="com/welie/blessed/BluetoothCentralManager.html" title="class in com.welie.blessed">BluetoothCentralManager</a></td>
<th class="colLast" scope="row">
<div class="block">Central Manager class to scan and connect with bluetooth peripherals.</div>
</th>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><a href="com/welie/blessed/BluetoothCentralManagerCallback.html" title="class in com.welie.blessed">BluetoothCentralManagerCallback</a></td>
<th class="colLast" scope="row">
<div class="block">Callbacks for the BluetoothCentralManager class</div>
</th>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><a href="com/welie/blessed/BluetoothPeripheral.html" title="class in com.welie.blessed">BluetoothPeripheral</a></td>
<th class="colLast" scope="row">
<div class="block">Represents a remote Bluetooth peripheral and replaces BluetoothDevice and BluetoothGatt</div>
</th>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><a href="com/welie/blessed/BluetoothPeripheralCallback.html" title="class in com.welie.blessed">BluetoothPeripheralCallback</a></td>
<th class="colLast" scope="row">
<div class="block">Callbacks for the BluetoothPeripheral class</div>
</th>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><a href="com/welie/blessed/BluetoothPeripheralManager.html" title="class in com.welie.blessed">BluetoothPeripheralManager</a></td>
<th class="colLast" scope="row">
<div class="block">This class represent a peripheral running on the local phone</div>
</th>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><a href="com/welie/blessed/BluetoothPeripheralManagerCallback.html" title="class in com.welie.blessed">BluetoothPeripheralManagerCallback</a></td>
<th class="colLast" scope="row">
<div class="block">Callbacks for the BluetoothPeripheralManager class</div>
</th>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><a href="com/welie/blessed/BondState.html" title="enum in com.welie.blessed">BondState</a></td>
<th class="colLast" scope="row">
<div class="block">The class represents the various possible bond states</div>
</th>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><a href="com/welie/blessed/ConnectionPriority.html" title="enum in com.welie.blessed">ConnectionPriority</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><a href="com/welie/blessed/ConnectionState.html" title="enum in com.welie.blessed">ConnectionState</a></td>
<th class="colLast" scope="row">
<div class="block">This class represents the possible connection states</div>
</th>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><a href="com/welie/blessed/GattStatus.html" title="enum in com.welie.blessed">GattStatus</a></td>
<th class="colLast" scope="row">
<div class="block">The GattStatus describes the result of a GATT operation.</div>
</th>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><a href="com/welie/blessed/HciStatus.html" title="enum in com.welie.blessed">HciStatus</a></td>
<th class="colLast" scope="row">
<div class="block">This class describes the HCI error codes as defined in the Bluetooth Standard, Volume 1, Part F, 1.3 HCI Error Code, pages 364-377.</div>
</th>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><a href="com/welie/blessed/PeripheralType.html" title="enum in com.welie.blessed">PeripheralType</a></td>
<th class="colLast" scope="row">
<div class="block">This class represents the possible peripheral types</div>
</th>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><a href="com/welie/blessed/PhyOptions.html" title="enum in com.welie.blessed">PhyOptions</a></td>
<th class="colLast" scope="row">
<div class="block">This class represents the possible Phy options</div>
</th>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><a href="com/welie/blessed/PhyType.html" title="enum in com.welie.blessed">PhyType</a></td>
<th class="colLast" scope="row">
<div class="block">This class represents the possible Phy types</div>
</th>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><a href="com/welie/blessed/ScanFailure.html" title="enum in com.welie.blessed">ScanFailure</a></td>
<th class="colLast" scope="row">
<div class="block">This class represents the possible scan failure reasons</div>
</th>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><a href="com/welie/blessed/ScanMode.html" title="enum in com.welie.blessed">ScanMode</a></td>
<th class="colLast" scope="row">
<div class="block">This class represents the possible scan modes</div>
</th>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><a href="com/welie/blessed/WriteType.html" title="enum in com.welie.blessed">WriteType</a></td>
<th class="colLast" scope="row">
<div class="block">WriteType describes the type of write that can be done</div>
</th>
</tr>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="com/welie/blessed/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-files/index-1.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
20 changes: 15 additions & 5 deletions docs/allclasses-noframe.html → docs/allclasses.html
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,26 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_242-release) on Mon Apr 05 10:43:39 CEST 2021 -->
<!-- Generated by javadoc (11.0.8) on Thu Jun 24 22:56:15 CEST 2021 -->
<title>All Classes</title>
<meta name="date" content="2021-04-05">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2021-06-24">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<main role="main" class="indexContainer">
<ul>
<li><a href="com/welie/blessed/AdvertiseError.html" title="enum in com.welie.blessed">AdvertiseError</a></li>
<li><a href="com/welie/blessed/BluetoothBytesParser.html" title="class in com.welie.blessed">BluetoothBytesParser</a></li>
Expand All @@ -33,6 +43,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/welie/blessed/ScanMode.html" title="enum in com.welie.blessed">ScanMode</a></li>
<li><a href="com/welie/blessed/WriteType.html" title="enum in com.welie.blessed">WriteType</a></li>
</ul>
</div>
</main>
</body>
</html>
Loading

0 comments on commit 300901e

Please sign in to comment.