fix javadoc

woodser · Feb 11, 2023 · 30fad78 · 30fad78
1 parent f71545b
commit 30fad78
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 22 deletions.
diff --git a/docs/member-search-index.zip b/docs/member-search-index.zip
diff --git a/docs/monero/common/TaskLooper.html b/docs/monero/common/TaskLooper.html
@@ -285,6 +285,8 @@ <h4>start</h4>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>periodInMs</code> - the loop period in milliseconds</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>this instance for chaining</dd>
 </dl>
 </li>
 </ul>

diff --git a/docs/monero/wallet/MoneroWallet.html b/docs/monero/wallet/MoneroWallet.html
@@ -2140,9 +2140,7 @@ <h4>getTx</h4>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>txHash</code> - is the hash of a transaction to get</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
-<dd>the identified transactions</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>MoneroError</code> - if the transaction is not found</dd>
+<dd>the identified transaction or throw if not found</dd>
 </dl>
 </li>
 </ul>
@@ -2173,9 +2171,7 @@ <h4>getTxs</h4>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>txHashes</code> - are hashes of transactions to get</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
-<dd>the identified transactions</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>MoneroError</code> - if a transaction is not found</dd>
+<dd>the identified transactions or throw if a transaction is not found</dd>
 </dl>
 </li>
 </ul>
@@ -2191,9 +2187,7 @@ <h4>getTxs</h4>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>txHashes</code> - are hashes of transactions to get</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
-<dd>the identified transactions</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>MoneroError</code> - if a transaction is not found</dd>
+<dd>the identified transactions or throw if a transaction is not found</dd>
 </dl>
 </li>
 </ul>

diff --git a/docs/monero/wallet/MoneroWalletFull.html b/docs/monero/wallet/MoneroWalletFull.html
@@ -3741,7 +3741,7 @@ <h4>getTx</h4>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>txHash</code> - is the hash of a transaction to get</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
-<dd>the identified transactions</dd>
+<dd>the identified transaction or throw if not found</dd>
 </dl>
 </li>
 </ul>
@@ -3778,7 +3778,7 @@ <h4>getTxs</h4>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>txHashes</code> - are hashes of transactions to get</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
-<dd>the identified transactions</dd>
+<dd>the identified transactions or throw if a transaction is not found</dd>
 </dl>
 </li>
 </ul>
@@ -3797,7 +3797,7 @@ <h4>getTxs</h4>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>txHashes</code> - are hashes of transactions to get</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
-<dd>the identified transactions</dd>
+<dd>the identified transactions or throw if a transaction is not found</dd>
 </dl>
 </li>
 </ul>

diff --git a/docs/monero/wallet/MoneroWalletRpc.html b/docs/monero/wallet/MoneroWalletRpc.html
@@ -3806,7 +3806,7 @@ <h4>getTx</h4>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>txHash</code> - is the hash of a transaction to get</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
-<dd>the identified transactions</dd>
+<dd>the identified transaction or throw if not found</dd>
 </dl>
 </li>
 </ul>
@@ -3843,7 +3843,7 @@ <h4>getTxs</h4>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>txHashes</code> - are hashes of transactions to get</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
-<dd>the identified transactions</dd>
+<dd>the identified transactions or throw if a transaction is not found</dd>
 </dl>
 </li>
 </ul>
@@ -3862,7 +3862,7 @@ <h4>getTxs</h4>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>txHashes</code> - are hashes of transactions to get</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
-<dd>the identified transactions</dd>
+<dd>the identified transactions or throw if a transaction is not found</dd>
 </dl>
 </li>
 </ul>

diff --git a/docs/overview-summary.html b/docs/overview-summary.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.11) on Sat Feb 11 14:21:58 EST 2023 -->
+<!-- Generated by javadoc (11.0.11) on Sat Feb 11 15:12:04 EST 2023 -->
 <title>Generated Documentation (Untitled)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <script type="text/javascript">window.location.replace('index.html')</script>

diff --git a/docs/package-search-index.zip b/docs/package-search-index.zip
diff --git a/docs/type-search-index.zip b/docs/type-search-index.zip
diff --git a/src/main/java/monero/common/TaskLooper.java b/src/main/java/monero/common/TaskLooper.java
@@ -34,6 +34,7 @@ public Runnable getTask() {
    * Start the task loop.
    * 
    * @param periodInMs the loop period in milliseconds
+   * @return this instance for chaining
    */
   public synchronized TaskLooper start(long periodInMs) {
     synchronized (this) {

diff --git a/src/main/java/monero/wallet/MoneroWallet.java b/src/main/java/monero/wallet/MoneroWallet.java
@@ -494,8 +494,7 @@ public interface MoneroWallet {
    * Get a wallet transaction by hash.
    * 
    * @param txHash is the hash of a transaction to get
-   * @return the identified transactions
-   * @throws MoneroError if the transaction is not found
+   * @return the identified transaction or throw if not found
    */
   public MoneroTxWallet getTx(String txHash);
 
@@ -511,17 +510,15 @@ public interface MoneroWallet {
    * Get wallet transactions by hash.
    * 
    * @param txHashes are hashes of transactions to get
-   * @return the identified transactions
-   * @throws MoneroError if a transaction is not found
+   * @return the identified transactions or throw if a transaction is not found
    */
   public List<MoneroTxWallet> getTxs(String... txHashes);
 
   /**
    * Get wallet transactions by hash.
    * 
    * @param txHashes are hashes of transactions to get
-   * @return the identified transactions
-   * @throws MoneroError if a transaction is not found
+   * @return the identified transactions or throw if a transaction is not found
    */
   public List<MoneroTxWallet> getTxs(List<String> txHashes);