Skip to content

Commit

Permalink
update javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
woodser committed Apr 28, 2024
1 parent d969910 commit d204e15
Show file tree
Hide file tree
Showing 10 changed files with 259 additions and 144 deletions.
8 changes: 8 additions & 0 deletions docs/javadocs/index-files/index-18.html
Original file line number Diff line number Diff line change
Expand Up @@ -1193,6 +1193,10 @@ <h2 class="title" id="I:S">S</h2>
<dd>
<div class="block">Set the maximum request time before a connection is considered offline.</div>
</dd>
<dt><a href="../monero/common/MoneroRpcConnection.html#setTimeout(java.lang.Long)" class="member-name-link">setTimeout(Long)</a> - Method in class monero.common.<a href="../monero/common/MoneroRpcConnection.html" title="class in monero.common">MoneroRpcConnection</a></dt>
<dd>
<div class="block">Set the RPC request timeout in milliseconds.</div>
</dd>
<dt><a href="../monero/daemon/model/MoneroBlock.html#setTimestamp(java.lang.Long)" class="member-name-link">setTimestamp(Long)</a> - Method in class monero.daemon.model.<a href="../monero/daemon/model/MoneroBlock.html" title="class in monero.daemon.model">MoneroBlock</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../monero/daemon/model/MoneroBlockHeader.html#setTimestamp(java.lang.Long)" class="member-name-link">setTimestamp(Long)</a> - Method in class monero.daemon.model.<a href="../monero/daemon/model/MoneroBlockHeader.html" title="class in monero.daemon.model">MoneroBlockHeader</a></dt>
Expand Down Expand Up @@ -1379,6 +1383,10 @@ <h2 class="title" id="I:S">S</h2>
<dd>
<div class="block">Start the task loop.</div>
</dd>
<dt><a href="../monero/common/TaskLooper.html#start(long,boolean)" class="member-name-link">start(long, boolean)</a> - Method in class monero.common.<a href="../monero/common/TaskLooper.html" title="class in monero.common">TaskLooper</a></dt>
<dd>
<div class="block">Start the task loop.</div>
</dd>
<dt><a href="../monero/wallet/MoneroWallet.html#startMining(java.lang.Long,java.lang.Boolean,java.lang.Boolean)" class="member-name-link">startMining(Long, Boolean, Boolean)</a> - Method in interface monero.wallet.<a href="../monero/wallet/MoneroWallet.html" title="interface in monero.wallet">MoneroWallet</a></dt>
<dd>
<div class="block">Start mining.</div>
Expand Down
6 changes: 6 additions & 0 deletions docs/javadocs/index-files/index-7.html
Original file line number Diff line number Diff line change
Expand Up @@ -991,6 +991,10 @@ <h2 class="title" id="I:G">G</h2>
<dd>&nbsp;</dd>
<dt><a href="../monero/wallet/model/MoneroTxQuery.html#getPaymentIds()" class="member-name-link">getPaymentIds()</a> - Method in class monero.wallet.model.<a href="../monero/wallet/model/MoneroTxQuery.html" title="class in monero.wallet.model">MoneroTxQuery</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../monero/common/MoneroUtils.html#getPaymentUri(monero.wallet.model.MoneroTxConfig)" class="member-name-link">getPaymentUri(MoneroTxConfig)</a> - Static method in class monero.common.<a href="../monero/common/MoneroUtils.html" title="class in monero.common">MoneroUtils</a></dt>
<dd>
<div class="block">Creates a payment URI from a tx configuration.</div>
</dd>
<dt><a href="../monero/wallet/MoneroWallet.html#getPaymentUri(monero.wallet.model.MoneroTxConfig)" class="member-name-link">getPaymentUri(MoneroTxConfig)</a> - Method in interface monero.wallet.<a href="../monero/wallet/MoneroWallet.html" title="interface in monero.wallet">MoneroWallet</a></dt>
<dd>
<div class="block">Creates a payment URI from a send configuration.</div>
Expand Down Expand Up @@ -1351,6 +1355,8 @@ <h2 class="title" id="I:G">G</h2>
<dd>
<div class="block">Get the request timeout.</div>
</dd>
<dt><a href="../monero/common/MoneroRpcConnection.html#getTimeout()" class="member-name-link">getTimeout()</a> - Method in class monero.common.<a href="../monero/common/MoneroRpcConnection.html" title="class in monero.common">MoneroRpcConnection</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../monero/daemon/model/MoneroBlockHeader.html#getTimestamp()" class="member-name-link">getTimestamp()</a> - Method in class monero.daemon.model.<a href="../monero/daemon/model/MoneroBlockHeader.html" title="class in monero.daemon.model">MoneroBlockHeader</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../monero/daemon/model/MoneroDaemonInfo.html#getTopBlockHash()" class="member-name-link">getTopBlockHash()</a> - Method in class monero.daemon.model.<a href="../monero/daemon/model/MoneroDaemonInfo.html" title="class in monero.daemon.model">MoneroDaemonInfo</a></dt>
Expand Down
2 changes: 1 addition & 1 deletion docs/javadocs/member-search-index.js

Large diffs are not rendered by default.

163 changes: 95 additions & 68 deletions docs/javadocs/monero/common/MoneroRpcConnection.html

Large diffs are not rendered by default.

154 changes: 87 additions & 67 deletions docs/javadocs/monero/common/MoneroUtils.html

Large diffs are not rendered by default.

25 changes: 23 additions & 2 deletions docs/javadocs/monero/common/TaskLooper.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,15 @@ <h2>Method Summary</h2>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Start the task loop.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stop()" class="member-name-link">stop</a>()</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TaskLooper.html" title="class in monero.common">TaskLooper</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start(long,boolean)" class="member-name-link">start</a><wbr>(long&nbsp;periodInMs,
boolean&nbsp;targetFixedPeriod)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Start the task loop.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stop()" class="member-name-link">stop</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Stop the task loop.</div>
</div>
</div>
Expand Down Expand Up @@ -194,6 +200,21 @@ <h3>start</h3>
</section>
</li>
<li>
<section class="detail" id="start(long,boolean)">
<h3>start</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TaskLooper.html" title="class in monero.common">TaskLooper</a></span>&nbsp;<span class="element-name">start</span><wbr><span class="parameters">(long&nbsp;periodInMs,
boolean&nbsp;targetFixedPeriod)</span></div>
<div class="block">Start the task loop.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>periodInMs</code> - the loop period in milliseconds</dd>
<dd><code>targetFixedPeriod</code> - specifies if the task should target a fixed period by accounting for run time</dd>
<dt>Returns:</dt>
<dd>this instance for chaining</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isStarted()">
<h3>isStarted</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isStarted</span>()</div>
Expand Down
13 changes: 9 additions & 4 deletions docs/javadocs/monero/common/class-use/MoneroRpcConnection.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,19 @@ <h2>Uses of <a href="../MoneroRpcConnection.html" title="class in monero.common"
<div class="col-second even-row-color"><span class="type-name-label">MoneroRpcConnection.</span><code><a href="../MoneroRpcConnection.html#setProxyUri(java.lang.String)" class="member-name-link">setProxyUri</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;proxyUri)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../MoneroRpcConnection.html" title="class in monero.common">MoneroRpcConnection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">MoneroRpcConnection.</span><code><a href="../MoneroRpcConnection.html#setUri(java.lang.String)" class="member-name-link">setUri</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;uri)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-second odd-row-color"><span class="type-name-label">MoneroRpcConnection.</span><code><a href="../MoneroRpcConnection.html#setTimeout(java.lang.Long)" class="member-name-link">setTimeout</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>&nbsp;timeoutMs)</code></div>
<div class="col-last odd-row-color">
<div class="block">Set the RPC request timeout in milliseconds.</div>
</div>
<div class="col-first even-row-color"><code><a href="../MoneroRpcConnection.html" title="class in monero.common">MoneroRpcConnection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">MoneroRpcConnection.</span><code><a href="../MoneroRpcConnection.html#setUri(java.net.URI)" class="member-name-link">setUri</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;uri)</code></div>
<div class="col-second even-row-color"><span class="type-name-label">MoneroRpcConnection.</span><code><a href="../MoneroRpcConnection.html#setUri(java.lang.String)" class="member-name-link">setUri</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;uri)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../MoneroRpcConnection.html" title="class in monero.common">MoneroRpcConnection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">MoneroRpcConnection.</span><code><a href="../MoneroRpcConnection.html#setZmqUri(java.lang.String)" class="member-name-link">setZmqUri</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;zmqUri)</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">MoneroRpcConnection.</span><code><a href="../MoneroRpcConnection.html#setUri(java.net.URI)" class="member-name-link">setUri</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;uri)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../MoneroRpcConnection.html" title="class in monero.common">MoneroRpcConnection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">MoneroRpcConnection.</span><code><a href="../MoneroRpcConnection.html#setZmqUri(java.lang.String)" class="member-name-link">setZmqUri</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;zmqUri)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">monero.common</a> that return types with arguments of type <a href="../MoneroRpcConnection.html" title="class in monero.common">MoneroRpcConnection</a></span></div>
<div class="summary-table three-column-summary">
Expand Down
6 changes: 6 additions & 0 deletions docs/javadocs/monero/common/class-use/TaskLooper.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,12 @@ <h2>Uses of <a href="../TaskLooper.html" title="class in monero.common">TaskLoop
<div class="col-last even-row-color">
<div class="block">Start the task loop.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../TaskLooper.html" title="class in monero.common">TaskLooper</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">TaskLooper.</span><code><a href="../TaskLooper.html#start(long,boolean)" class="member-name-link">start</a><wbr>(long&nbsp;periodInMs,
boolean&nbsp;targetFixedPeriod)</code></div>
<div class="col-last odd-row-color">
<div class="block">Start the task loop.</div>
</div>
</div>
</section>
</li>
Expand Down
22 changes: 20 additions & 2 deletions docs/javadocs/monero/wallet/model/class-use/MoneroTxConfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,32 @@ <h1 title="Uses of Class monero.wallet.model.MoneroTxConfig" class="title">Uses
<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="#monero.wallet">monero.wallet</a></div>
<div class="col-first even-row-color"><a href="#monero.common">monero.common</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#monero.wallet.model">monero.wallet.model</a></div>
<div class="col-first odd-row-color"><a href="#monero.wallet">monero.wallet</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="#monero.wallet.model">monero.wallet.model</a></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="monero.common">
<h2>Uses of <a href="../MoneroTxConfig.html" title="class in monero.wallet.model">MoneroTxConfig</a> in <a href="../../../common/package-summary.html">monero.common</a></h2>
<div class="caption"><span>Methods in <a href="../../../common/package-summary.html">monero.common</a> with parameters of type <a href="../MoneroTxConfig.html" title="class in monero.wallet.model">MoneroTxConfig</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">MoneroUtils.</span><code><a href="../../../common/MoneroUtils.html#getPaymentUri(monero.wallet.model.MoneroTxConfig)" class="member-name-link">getPaymentUri</a><wbr>(<a href="../MoneroTxConfig.html" title="class in monero.wallet.model">MoneroTxConfig</a>&nbsp;config)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a payment URI from a tx configuration.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="monero.wallet">
<h2>Uses of <a href="../MoneroTxConfig.html" title="class in monero.wallet.model">MoneroTxConfig</a> in <a href="../../package-summary.html">monero.wallet</a></h2>
<div class="caption"><span>Methods in <a href="../../package-summary.html">monero.wallet</a> that return <a href="../MoneroTxConfig.html" title="class in monero.wallet.model">MoneroTxConfig</a></span></div>
Expand Down
4 changes: 4 additions & 0 deletions docs/javadocs/monero/wallet/model/package-use.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ <h1 title="Uses of Package monero.wallet.model" class="title">Uses of Package<br
<div class="col-last odd-row-color">
<div class="block">Monero integrated address model.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/MoneroTxConfig.html#monero.common">MoneroTxConfig</a></div>
<div class="col-last even-row-color">
<div class="block">Configures a transaction to send, sweep, or create a payment URI.</div>
</div>
</div>
</section>
</li>
Expand Down

0 comments on commit d204e15

Please sign in to comment.