Skip to content

Commit

Permalink
add javadoc for v0.5.4
Browse files Browse the repository at this point in the history
  • Loading branch information
@oldratlee
oldratlee committed Apr 11, 2024
1 parent 8e4080a commit 3a59b35
Show file tree
Hide file tree
Showing 46 changed files with 5,459 additions and 1 deletion.
103 changes: 103 additions & 0 deletions apidocs/0.5.4/allclasses-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Wed Apr 10 19:46:18 CST 2024 -->
<title>All Classes and Interfaces (Inspectable Wrappers 0.5.4 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-04-10">
<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.6.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 evenRowColor = "even-row-color";
var oddRowColor = "odd-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="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="index-all.html">Index</a></li>
<li><a href="help-doc.html#all-classes">Help</a></li>
</ul>
</div>
<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>
</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 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-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">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></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-tab1"><a href="io/foldright/inspectablewrappers/Attachable.html" title="interface in io.foldright.inspectablewrappers">Attachable</a>&lt;<a href="io/foldright/inspectablewrappers/Attachable.html" title="type parameter in Attachable">K</a>,<wbr><a href="io/foldright/inspectablewrappers/Attachable.html" title="type parameter in Attachable">V</a>&gt;</div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">This <code>Attachable</code> interface is used to be implemented by wrapper classes,
provide the attachment storage ability.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/foldright/inspectablewrappers/utils/AttachableDelegate.html" title="class in io.foldright.inspectablewrappers.utils">AttachableDelegate</a>&lt;<a href="io/foldright/inspectablewrappers/utils/AttachableDelegate.html" title="type parameter in AttachableDelegate">K</a>,<wbr><a href="io/foldright/inspectablewrappers/utils/AttachableDelegate.html" title="type parameter in AttachableDelegate">V</a>&gt;</div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">A simple <a href="io/foldright/inspectablewrappers/Attachable.html" title="interface in io.foldright.inspectablewrappers"><code>Attachable</code></a> delegate implementation.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/foldright/inspectablewrappers/Inspector.html" title="class in io.foldright.inspectablewrappers">Inspector</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">This <code>Inspector</code> class is used to inspect the wrapper chain.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/foldright/inspectablewrappers/Wrapper.html" title="interface in io.foldright.inspectablewrappers">Wrapper</a>&lt;<a href="io/foldright/inspectablewrappers/Wrapper.html" title="type parameter in Wrapper">T</a>&gt;</div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">This <code>Wrapper</code> interface is used to be implemented by wrapper classes,
make an <strong>inspectable wrapper chain</strong>(linked list).</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/foldright/inspectablewrappers/WrapperAdapter.html" title="interface in io.foldright.inspectablewrappers">WrapperAdapter</a>&lt;<a href="io/foldright/inspectablewrappers/WrapperAdapter.html" title="type parameter in WrapperAdapter">T</a>&gt;</div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">This <code>WrapperAdapter</code> interface is used to
adapt an existed wrapper instance to type <a href="io/foldright/inspectablewrappers/Wrapper.html" title="interface in io.foldright.inspectablewrappers"><code>Wrapper</code></a> without modifying it.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/foldright/inspectablewrappers/utils/WrapperAdapterUtils.html" title="class in io.foldright.inspectablewrappers.utils">WrapperAdapterUtils</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Utility class for creating <a href="io/foldright/inspectablewrappers/WrapperAdapter.html" title="interface in io.foldright.inspectablewrappers"><code>WrapperAdapter</code></a> instances
without writing boilerplate codes of creating new adapter classes.</div>
</div>
</div>
</div>
</div>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023&#x2013;2024 <a href="https://foldright.io">FoldRight</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
75 changes: 75 additions & 0 deletions apidocs/0.5.4/allpackages-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Wed Apr 10 19:46:18 CST 2024 -->
<title>All Packages (Inspectable Wrappers 0.5.4 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-04-10">
<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.6.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="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="index-all.html">Index</a></li>
<li><a href="help-doc.html#all-packages">Help</a></li>
</ul>
</div>
<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>
</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="caption"><span>Package Summary</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="io/foldright/inspectablewrappers/package-summary.html">io.foldright.inspectablewrappers</a></div>
<div class="col-last even-row-color">
<div class="block">🪐 Inspectable Wrappers Specification provides a standard for wrapper chain with the inspection ability.</div>
</div>
<div class="col-first odd-row-color"><a href="io/foldright/inspectablewrappers/utils/package-summary.html">io.foldright.inspectablewrappers.utils</a></div>
<div class="col-last odd-row-color">
<div class="block">Utility classes for <code>inspectable wrappers</code>.</div>
</div>
</div>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023&#x2013;2024 <a href="https://foldright.io">FoldRight</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
2 changes: 2 additions & 0 deletions apidocs/0.5.4/element-list
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
io.foldright.inspectablewrappers
io.foldright.inspectablewrappers.utils
Loading

0 comments on commit 3a59b35

Please sign in to comment.