Skip to content
This repository has been archived by the owner on Mar 7, 2022. It is now read-only.

Commit

Permalink
REL: 1.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@lucboruta
lucboruta committed Jul 28, 2021
1 parent 6fb688c commit 27c6bc5
Show file tree
Hide file tree
Showing 57 changed files with 4,825 additions and 4,812 deletions.
5 changes: 2 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

[![Release](https://jitpack.io/v/thunken/beacon.svg?style=flat-square)](https://github.com/thunken/beacon/releases)

To add a dependency on this project using Gradle, Maven, sbt, or Leiningen, we recommend using [JitPack](https://jitpack.io/#thunken/beacon/1.1.1). The Maven group ID is `com.github.thunken`, and the artifact ID is `beacon`.
To add a dependency on this project using Gradle, Maven, sbt, or Leiningen, we recommend using [JitPack](https://jitpack.io/#thunken/beacon/1.2.0). The Maven group ID is `com.github.thunken`, and the artifact ID is `beacon`.

For example, for Maven, first add the JitPack repository to your build file:
```xml
Expand All @@ -23,14 +23,13 @@ And then add the dependency:
<dependency>
<groupId>com.github.thunken</groupId>
<artifactId>beacon</artifactId>
<version>1.1.1</version>
<version>1.2.0</version>
</dependency>
```

## Documentation

* Javadoc: https://thunken.github.io/beacon/
* Note: the current Javadoc for this project is incomplete. We rely on [Lombok](https://projectlombok.org/) to generate boilerplate code, and Lombok does not plug into Javadoc. Generated methods and constructors are not included, and the Javadoc for other methods and constructors may be incomplete. See [delombok](https://projectlombok.org/features/delombok) and [beacon#1](https://github.com/thunken/beacon/issues/1) for more information.
* BEACON specification: https://gbv.github.io/beaconspec/beacon.html

## Related projects
Expand Down
147 changes: 147 additions & 0 deletions docs/allclasses-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes (beacon 1.2.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="all-classes-index-page">
<script type="text/javascript">var data = {"i0":8,"i1":2,"i2":4,"i3":4,"i4":4,"i5":2,"i6":2,"i7":4};
var tabs = {65535:["t0","All Classes"],2:["t2","Class Summary"],4:["t3","Enum Summary"],8:["t4","Exception Summary"]};
var altColor = "alt-color";
var rowColor = "row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar.top">
<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
<li><a href="com/thunken/beacon/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="com/thunken/beacon/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip.navbar.top">
<!-- -->
</span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</div>
<div class="type-summary" id="all-classes-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Classes</button><button role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Class Summary</button><button role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="table-tab" onclick="show(4);">Enum Summary</button><button role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="table-tab" onclick="show(8);">Exception Summary</button></div>
<div id="all-classes-table.tabpanel" role="tabpanel">
<table class="summary-table" aria-labelledby="t0">
<thead>
<tr>
<th class="col-first" scope="col">Class</th>
<th class="col-last" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="alt-color" id="i0">
<td class="col-first"><a href="com/thunken/beacon/BeaconFormatException.html" title="class in com.thunken.beacon">BeaconFormatException</a></td>
<th class="col-last" scope="row">
<div class="block">Thrown to indicate that a method has been passed data that violates the BEACON specification.</div>
</th>
</tr>
<tr class="row-color" id="i1">
<td class="col-first"><a href="com/thunken/beacon/BeaconLink.html" title="class in com.thunken.beacon">BeaconLink</a></td>
<th class="col-last" scope="row">
<div class="block">Main class for BEACON links.</div>
</th>
</tr>
<tr class="alt-color" id="i2">
<td class="col-first"><a href="com/thunken/beacon/BeaconMetaField.html" title="enum in com.thunken.beacon">BeaconMetaField</a></td>
<th class="col-last" scope="row">
<div class="block">Enumerated type for BEACON meta fields.</div>
</th>
</tr>
<tr class="row-color" id="i3">
<td class="col-first"><a href="com/thunken/beacon/BeaconMetaField.Type.html" title="enum in com.thunken.beacon">BeaconMetaField.Type</a></td>
<th class="col-last" scope="row">
<div class="block">Enumerated type for BEACON meta field types.</div>
</th>
</tr>
<tr class="alt-color" id="i4">
<td class="col-first"><a href="com/thunken/beacon/BeaconMetaField.ValueType.html" title="enum in com.thunken.beacon">BeaconMetaField.ValueType</a></td>
<th class="col-last" scope="row">&nbsp;</th>
</tr>
<tr class="row-color" id="i5">
<td class="col-first"><a href="com/thunken/beacon/BeaconMetaFields.html" title="class in com.thunken.beacon">BeaconMetaFields</a></td>
<th class="col-last" scope="row">
<div class="block">Custom collection to hold multiple BEACON meta fields and their respective values.</div>
</th>
</tr>
<tr class="alt-color" id="i6">
<td class="col-first"><a href="com/thunken/beacon/BeaconParser.html" title="class in com.thunken.beacon">BeaconParser</a></td>
<th class="col-last" scope="row">
<div class="block">Main class to parse BEACON dumps.</div>
</th>
</tr>
<tr class="row-color" id="i7">
<td class="col-first"><a href="com/thunken/beacon/BeaconUpdate.html" title="enum in com.thunken.beacon">BeaconUpdate</a></td>
<th class="col-last" scope="row">
<div class="block">Enumerated type for BEACON dump update frequencies.</div>
</th>
</tr>
</tbody>
</table>
</div>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottom-nav" id="navbar.bottom">
<div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar.bottom.firstrow" class="nav-list" title="Navigation">
<li><a href="com/thunken/beacon/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="com/thunken/beacon/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<span class="skip-nav" id="skip.navbar.bottom">
<!-- -->
</span></nav>
<p class="legal-copy"><small>Copyright &#169; 2021. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
99 changes: 99 additions & 0 deletions docs/allpackages-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Packages (beacon 1.2.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="all-packages-index-page">
<script type="text/javascript">var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar.top">
<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
<li><a href="com/thunken/beacon/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="com/thunken/beacon/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip.navbar.top">
<!-- -->
</span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
</div>
<div class="packages-summary">
<table class="summary-table">
<caption><span>Package Summary</span></caption>
<thead>
<tr>
<th class="col-first" scope="col">Package</th>
<th class="col-last" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="alt-color">
<th class="col-first" scope="row"><a href="com/thunken/beacon/package-summary.html">com.thunken.beacon</a></th>
<td class="col-last">
<div class="block">Utilities for BEACON, a data interchange format for large numbers of uniform links.</div>
</td>
</tr>
</tbody>
</table>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottom-nav" id="navbar.bottom">
<div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar.bottom.firstrow" class="nav-list" title="Navigation">
<li><a href="com/thunken/beacon/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="com/thunken/beacon/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<span class="skip-nav" id="skip.navbar.bottom">
<!-- -->
</span></nav>
<p class="legal-copy"><small>Copyright &#169; 2021. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
Loading

0 comments on commit 27c6bc5

Please sign in to comment.