Skip to content

Commit

Permalink
regen javadocs (#103)
Browse files Browse the repository at this point in the history
* regen javadocs

* update readme

* try nuclear option

* pin version

* moar
  • Loading branch information
dylanrb123 authored Dec 13, 2024
1 parent 1c9e495 commit dad8276
Show file tree
Hide file tree
Showing 161 changed files with 4,110 additions and 40,015 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Add the following artifact to your `pom.xml`:
<dependency>
<groupId>com.spotify</groupId>
<artifactId>voyager</artifactId>
<version>2.0.4</version>
<version>2.1.0</version>
</dependency>
```
You can find the latest version on [Voyager's Releases page](https://github.com/spotify/voyager/releases).
Expand All @@ -43,7 +43,7 @@ You can find the latest version on [Voyager's Releases page](https://github.com/

Add the following artifact to your `build.sbt`:
```sbt
"com.spotify" % "voyager" % "2.0.4"
"com.spotify" % "voyager" % "2.1.0"
```
You can find the latest version on [Voyager's Releases page](https://github.com/spotify/voyager/releases).

Expand Down
28 changes: 28 additions & 0 deletions docs/java/allclasses-frame.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_432) on Fri Dec 13 16:58:43 EST 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (voyager 2.1.0 API)</title>
<meta name="date" content="2024-12-13">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="com/spotify/voyager/jni/Index.html" title="class in com.spotify.voyager.jni" target="classFrame">Index</a></li>
<li><a href="com/spotify/voyager/jni/Index.QueryResults.html" title="class in com.spotify.voyager.jni" target="classFrame">Index.QueryResults</a></li>
<li><a href="com/spotify/voyager/jni/Index.SpaceType.html" title="enum in com.spotify.voyager.jni" target="classFrame">Index.SpaceType</a></li>
<li><a href="com/spotify/voyager/jni/Index.StorageDataType.html" title="enum in com.spotify.voyager.jni" target="classFrame">Index.StorageDataType</a></li>
<li><a href="com/spotify/voyager/jni/utils/JniLibExtractor.html" title="class in com.spotify.voyager.jni.utils" target="classFrame">JniLibExtractor</a></li>
<li><a href="com/spotify/voyager/jni/exception/RecallException.html" title="class in com.spotify.voyager.jni.exception" target="classFrame">RecallException</a></li>
<li><a href="com/spotify/voyager/jni/StringIndex.html" title="class in com.spotify.voyager.jni" target="classFrame">StringIndex</a></li>
<li><a href="com/spotify/voyager/jni/StringIndex.QueryResults.html" title="class in com.spotify.voyager.jni" target="classFrame">StringIndex.QueryResults</a></li>
<li><a href="com/spotify/voyager/jni/utils/TinyJson.html" title="class in com.spotify.voyager.jni.utils" target="classFrame">TinyJson</a></li>
</ul>
</div>
</body>
</html>
241 changes: 68 additions & 173 deletions docs/java/allclasses-index.html
Original file line number Diff line number Diff line change
@@ -1,217 +1,112 @@
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang>
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.22) on Thu Aug 01 15:48:24 EDT 2024 -->
<title>All Classes (voyager 2.0.9 API)</title>
<!-- Generated by javadoc (17) on Fri Dec 13 16:48:08 EST 2024 -->
<title>All Classes and Interfaces (voyager 2.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2024-08-01">
<meta name="dc.created" content="2024-12-13">
<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="jquery/jquery-ui.min.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="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.6.1.min.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="All Classes (voyager 2.0.9 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":2,"i1":2,"i2":4,"i3":4,"i4":2,"i5":2,"i6":2,"i7":2};
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";
<body class="all-classes-index-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "./";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<div class="flex-box">
<header role="banner" class="flex-header">
<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">
<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="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>
<li><a href="help-doc.html#all-classes">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 class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</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>
<!-- ========= 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="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/spotify/voyager/jni/Index.html" title="class in com.spotify.voyager.jni">Index</a></td>
<th class="colLast" scope="row">
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
</div>
<div id="all-classes-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enums</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exceptions</button></div>
<div id="all-classes-table.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spotify/voyager/jni/Index.html" title="class in com.spotify.voyager.jni">Index</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A Voyager index, providing storage of floating-point vectors and the ability to efficiently
search among those vectors.</div>
</th>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><a href="com/spotify/voyager/jni/Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a></td>
<th class="colLast" scope="row">
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spotify/voyager/jni/Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">A container for query results, returned by Index.</div>
</th>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><a href="com/spotify/voyager/jni/Index.SpaceType.html" title="enum in com.spotify.voyager.jni">Index.SpaceType</a></td>
<th class="colLast" scope="row">
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="com/spotify/voyager/jni/Index.SpaceType.html" title="enum in com.spotify.voyager.jni">Index.SpaceType</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">The space, also known as distance metric, to use when searching.</div>
</th>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><a href="com/spotify/voyager/jni/Index.StorageDataType.html" title="enum in com.spotify.voyager.jni">Index.StorageDataType</a></td>
<th class="colLast" scope="row">
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="com/spotify/voyager/jni/Index.StorageDataType.html" title="enum in com.spotify.voyager.jni">Index.StorageDataType</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="block">The datatype used to use when storing vectors on disk.</div>
</th>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><a href="com/spotify/voyager/jni/utils/JniLibExtractor.html" title="class in com.spotify.voyager.jni.utils">JniLibExtractor</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><a href="com/spotify/voyager/jni/StringIndex.html" title="class in com.spotify.voyager.jni">StringIndex</a></td>
<th class="colLast" scope="row">
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spotify/voyager/jni/utils/JniLibExtractor.html" title="class in com.spotify.voyager.jni.utils">JniLibExtractor</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="com/spotify/voyager/jni/exception/RecallException.html" title="class in com.spotify.voyager.jni.exception">RecallException</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
<div class="block">An exception indicating that the desired recall of a query cannot be achieved</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spotify/voyager/jni/StringIndex.html" title="class in com.spotify.voyager.jni">StringIndex</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Wrapper around com.spotify.voyager.jni.Index with a simplified interface which maps the index ID
to a provided String.</div>
</th>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><a href="com/spotify/voyager/jni/StringIndex.QueryResults.html" title="class in com.spotify.voyager.jni">StringIndex.QueryResults</a></td>
<th class="colLast" scope="row">
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/spotify/voyager/jni/StringIndex.QueryResults.html" title="class in com.spotify.voyager.jni">StringIndex.QueryResults</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">A wrapper class for nearest neighbor query results.</div>
</th>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><a href="com/spotify/voyager/jni/utils/TinyJson.html" title="class in com.spotify.voyager.jni.utils">TinyJson</a></td>
<th class="colLast" scope="row">
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/spotify/voyager/jni/utils/TinyJson.html" title="class in com.spotify.voyager.jni.utils">TinyJson</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A dependency-free, super tiny JSON serde class that only supports reading and writing lists of
strings.</div>
</th>
</tr>
</table>
</li>
</ul>
</div>
</div>
</div>
</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="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
</footer>
</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>
<p class="legalCopy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
</footer>
</body>
</html>
22 changes: 6 additions & 16 deletions docs/java/allclasses.html → docs/java/allclasses-noframe.html
Original file line number Diff line number Diff line change
@@ -1,25 +1,15 @@
<!DOCTYPE HTML>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang>
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.22) on Thu Aug 01 15:48:24 EDT 2024 -->
<title>All Classes (voyager 2.0.9 API)</title>
<!-- Generated by javadoc (1.8.0_432) on Fri Dec 13 16:58:43 EST 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2024-08-01">
<title>All Classes (voyager 2.1.0 API)</title>
<meta name="date" content="2024-12-13">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/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="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.6.1.min.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.min.js"></script>
</head>
<body>
<main role="main">
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
Expand All @@ -28,11 +18,11 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/spotify/voyager/jni/Index.SpaceType.html" title="enum in com.spotify.voyager.jni">Index.SpaceType</a></li>
<li><a href="com/spotify/voyager/jni/Index.StorageDataType.html" title="enum in com.spotify.voyager.jni">Index.StorageDataType</a></li>
<li><a href="com/spotify/voyager/jni/utils/JniLibExtractor.html" title="class in com.spotify.voyager.jni.utils">JniLibExtractor</a></li>
<li><a href="com/spotify/voyager/jni/exception/RecallException.html" title="class in com.spotify.voyager.jni.exception">RecallException</a></li>
<li><a href="com/spotify/voyager/jni/StringIndex.html" title="class in com.spotify.voyager.jni">StringIndex</a></li>
<li><a href="com/spotify/voyager/jni/StringIndex.QueryResults.html" title="class in com.spotify.voyager.jni">StringIndex.QueryResults</a></li>
<li><a href="com/spotify/voyager/jni/utils/TinyJson.html" title="class in com.spotify.voyager.jni.utils">TinyJson</a></li>
</ul>
</div>
</main>
</body>
</html>
Loading

0 comments on commit dad8276

Please sign in to comment.