Skip to content

Commit

Permalink
Update javadocs.
Browse files Browse the repository at this point in the history
  • Loading branch information
broneill committed Oct 4, 2024
1 parent 430afa5 commit 7e61c14
Show file tree
Hide file tree
Showing 9 changed files with 288 additions and 99 deletions.
103 changes: 54 additions & 49 deletions docs/javadoc/allclasses-index.html

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions docs/javadoc/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,11 @@ <h2 class="title" id="I:A">A</h2>
<dd>
<div class="block">Called when this object has been attached to a session and can be accessed remotely.</div>
</dd>
<dt><a href="org.cojen.dirmi/org/cojen/dirmi/AutoDispose.html" class="type-name-link" title="annotation interface in org.cojen.dirmi">AutoDispose</a> - Annotation Interface in <a href="org.cojen.dirmi/org/cojen/dirmi/package-summary.html">org.cojen.dirmi</a></dt>
<dd>
<div class="block">Designates a remote interface as supporting automatic disposal when the client-side object
is reclaimed by the garbage collector.</div>
</dd>
</dl>
<h2 class="title" id="I:B">B</h2>
<dl class="index">
Expand Down
102 changes: 102 additions & 0 deletions docs/javadoc/org.cojen.dirmi/org/cojen/dirmi/AutoDispose.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (23) -->
<title>AutoDispose (Dirmi 2.4.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="description" content="declaration: module: org.cojen.dirmi, package: org.cojen.dirmi, annotation type: AutoDispose">
<meta name="generator" content="javadoc/ClassWriter">
<link rel="stylesheet" type="text/css" href="../../../../resource-files/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../resource-files/stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script-files/script.js"></script>
<script type="text/javascript" src="../../../../script-files/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../../script-files/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">const pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="nav-content">
<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button></div>
<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="../../../module-summary.html">Module</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/AutoDispose.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../search.html">Search</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
</div>
<div class="sub-nav">
<div class="nav-content">
<ol class="sub-nav-list">
<li><a href="../../../module-summary.html">org.cojen.dirmi</a></li>
<li><a href="package-summary.html">org.cojen.dirmi</a></li>
<li><a href="AutoDispose.html" class="current-selection">AutoDispose</a></li>
</ol>
<div class="nav-list-search">
<input type="text" id="search-input" disabled placeholder="Search" aria-label="Search in documentation" autocomplete="off">
<input type="reset" id="reset-search" disabled value="Reset">
</div>
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="main-grid">
<nav role="navigation" class="toc" aria-label="Table of contents">
<div class="toc-header">Contents&nbsp;
<input type="text" class="filter-input" disabled placeholder="Filter" aria-label="Filter table of contents" autocomplete="off">
<input type="reset" class="reset-filter" disabled value="Reset">
</div>
<button class="hide-sidebar"><span>Hide sidebar&nbsp;</span>&#10094;</button><button class="show-sidebar">&#10095;<span>&nbsp;Show sidebar</span></button>
<ol class="toc-list">
<li><a href="#" tabindex="0">Description</a></li>
</ol>
</nav>
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<h1 title="Annotation Interface AutoDispose" class="title">Annotation Interface AutoDispose</h1>
</div>
<section class="class-description" id="class-description">
<div class="horizontal-scroll">
<hr>
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a>
<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/ElementType.html#TYPE" title="class or interface in java.lang.annotation" class="external-link">TYPE</a>)
</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">AutoDispose</span></div>
<div class="block">Designates a remote interface as supporting automatic disposal when the client-side object
is reclaimed by the garbage collector. Automatic disposal doesn't work for the <a href="Session.html#root()"><code>root</code></a> object, and it doesn't work when a reference cycle is formed between
client-side and remote-side objects.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="Disposer.html" title="annotation interface in org.cojen.dirmi"><code>Disposer</code></a></li>
<li><a href="Session.html#dispose(java.lang.Object)"><code>Session.dispose(java.lang.Object)</code></a></li>
</ul>
</dd>
</dl>
</div>
</section>
<section class="details" id="annotation-interface-element-detail"></section>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2006&#x2013;2024 <a href="https://github.com/cojen">Cojen</a>. All rights reserved.</small></p>
</footer>
</main>
</div>
</body>
</html>
1 change: 1 addition & 0 deletions docs/javadoc/org.cojen.dirmi/org/cojen/dirmi/Disposer.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ <h1 title="Annotation Interface Disposer" class="title">Annotation Interface Dis
<ul class="tag-list-long">
<li><a href="SessionAware.html" title="interface in org.cojen.dirmi"><code>SessionAware</code></a></li>
<li><a href="Session.html#dispose(java.lang.Object)"><code>Session.dispose(java.lang.Object)</code></a></li>
<li><a href="AutoDispose.html" title="annotation interface in org.cojen.dirmi"><code>AutoDispose</code></a></li>
<li><a href="DisposedException.html" title="class in org.cojen.dirmi"><code>DisposedException</code></a></li>
</ul>
</dd>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (23) -->
<title>Uses of Annotation Interface org.cojen.dirmi.AutoDispose (Dirmi 2.4.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="description" content="use: module: org.cojen.dirmi, package: org.cojen.dirmi, annotation type: AutoDispose">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../resource-files/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../resource-files/stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script-files/script.js"></script>
<script type="text/javascript" src="../../../../../script-files/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-files/jquery-ui.min.js"></script>
</head>
<body class="class-use-page">
<script type="text/javascript">const pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="nav-content">
<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button></div>
<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="../../../../module-summary.html">Module</a></li>
<li><a href="../AutoDispose.html">Class</a></li>
<li class="nav-bar-cell1-rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../search.html">Search</a></li>
<li><a href="../../../../../help-doc.html#use">Help</a></li>
</ul>
</div>
</div>
<div class="sub-nav">
<div class="nav-content">
<ol class="sub-nav-list">
<li><a href="../../../../module-summary.html">org.cojen.dirmi</a></li>
<li><a href="../package-summary.html">org.cojen.dirmi</a></li>
<li><a href="../AutoDispose.html" class="current-selection">AutoDispose</a></li>
</ol>
<div class="nav-list-search">
<input type="text" id="search-input" disabled placeholder="Search" aria-label="Search in documentation" autocomplete="off">
<input type="reset" id="reset-search" disabled value="Reset">
</div>
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="main-grid">
<main role="main">
<div class="header">
<h1 title="Uses of Annotation Interface org.cojen.dirmi.AutoDispose" class="title">Uses of Annotation Interface<br>org.cojen.dirmi.AutoDispose</h1>
</div>
No usage of org.cojen.dirmi.AutoDispose
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2006&#x2013;2024 <a href="https://github.com/cojen">Cojen</a>. All rights reserved.</small></p>
</footer>
</main>
</div>
</body>
</html>
Loading

0 comments on commit 7e61c14

Please sign in to comment.