From 30fad785aa754e288ce6ea14bc042a6844607f0a Mon Sep 17 00:00:00 2001 From: woodser Date: Sat, 11 Feb 2023 15:12:15 -0500 Subject: [PATCH] fix javadoc --- docs/member-search-index.zip | Bin 16592 -> 16592 bytes docs/monero/common/TaskLooper.html | 2 ++ docs/monero/wallet/MoneroWallet.html | 12 +++--------- docs/monero/wallet/MoneroWalletFull.html | 6 +++--- docs/monero/wallet/MoneroWalletRpc.html | 6 +++--- docs/overview-summary.html | 2 +- docs/package-search-index.zip | Bin 267 -> 267 bytes docs/type-search-index.zip | Bin 869 -> 869 bytes src/main/java/monero/common/TaskLooper.java | 1 + src/main/java/monero/wallet/MoneroWallet.java | 9 +++------ 10 files changed, 16 insertions(+), 22 deletions(-) diff --git a/docs/member-search-index.zip b/docs/member-search-index.zip index e5bded72eacfc3e5b5388f64aa27880f28339710..8b9f6be227525e35fb8b8ca50eaef489b619cc08 100644 GIT binary patch delta 30 lcmcc6$atZVkte{LnMH(wgM)*ixpE^V#@KLCL~2#o*$ delta 30 lcmcc6$atZVkte{LnMH(wgM))%Z_!4c5(lQeMU$Hx`~Za&2=f2{ diff --git a/docs/monero/common/TaskLooper.html b/docs/monero/common/TaskLooper.html index ea599dfc..b0f10b4e 100644 --- a/docs/monero/common/TaskLooper.html +++ b/docs/monero/common/TaskLooper.html @@ -285,6 +285,8 @@

start

Parameters:
periodInMs - the loop period in milliseconds
+
Returns:
+
this instance for chaining
diff --git a/docs/monero/wallet/MoneroWallet.html b/docs/monero/wallet/MoneroWallet.html index 2b334d21..8aa9e8da 100644 --- a/docs/monero/wallet/MoneroWallet.html +++ b/docs/monero/wallet/MoneroWallet.html @@ -2140,9 +2140,7 @@

getTx

Parameters:
txHash - is the hash of a transaction to get
Returns:
-
the identified transactions
-
Throws:
-
MoneroError - if the transaction is not found
+
the identified transaction or throw if not found
@@ -2173,9 +2171,7 @@

getTxs

Parameters:
txHashes - are hashes of transactions to get
Returns:
-
the identified transactions
-
Throws:
-
MoneroError - if a transaction is not found
+
the identified transactions or throw if a transaction is not found
@@ -2191,9 +2187,7 @@

getTxs

Parameters:
txHashes - are hashes of transactions to get
Returns:
-
the identified transactions
-
Throws:
-
MoneroError - if a transaction is not found
+
the identified transactions or throw if a transaction is not found
diff --git a/docs/monero/wallet/MoneroWalletFull.html b/docs/monero/wallet/MoneroWalletFull.html index d08a9c9f..d61585b6 100644 --- a/docs/monero/wallet/MoneroWalletFull.html +++ b/docs/monero/wallet/MoneroWalletFull.html @@ -3741,7 +3741,7 @@

getTx

Parameters:
txHash - is the hash of a transaction to get
Returns:
-
the identified transactions
+
the identified transaction or throw if not found
@@ -3778,7 +3778,7 @@

getTxs

Parameters:
txHashes - are hashes of transactions to get
Returns:
-
the identified transactions
+
the identified transactions or throw if a transaction is not found
@@ -3797,7 +3797,7 @@

getTxs

Parameters:
txHashes - are hashes of transactions to get
Returns:
-
the identified transactions
+
the identified transactions or throw if a transaction is not found
diff --git a/docs/monero/wallet/MoneroWalletRpc.html b/docs/monero/wallet/MoneroWalletRpc.html index 6c145c1e..fab6cf9a 100644 --- a/docs/monero/wallet/MoneroWalletRpc.html +++ b/docs/monero/wallet/MoneroWalletRpc.html @@ -3806,7 +3806,7 @@

getTx

Parameters:
txHash - is the hash of a transaction to get
Returns:
-
the identified transactions
+
the identified transaction or throw if not found
@@ -3843,7 +3843,7 @@

getTxs

Parameters:
txHashes - are hashes of transactions to get
Returns:
-
the identified transactions
+
the identified transactions or throw if a transaction is not found
@@ -3862,7 +3862,7 @@

getTxs

Parameters:
txHashes - are hashes of transactions to get
Returns:
-
the identified transactions
+
the identified transactions or throw if a transaction is not found
diff --git a/docs/overview-summary.html b/docs/overview-summary.html index 57dd592a..509fdb1c 100644 --- a/docs/overview-summary.html +++ b/docs/overview-summary.html @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled) diff --git a/docs/package-search-index.zip b/docs/package-search-index.zip index ad7100b370be3a84a7ff7f9a93c86e97a1e1cd49..7ac3d5ac27e9c6a482610acff2be6991ce5a0bcc 100644 GIT binary patch delta 26 gcmeBX>Sp2z@MdNaVc_84U}&zK$g_?KNbd0m07%FN)&Kwi delta 26 gcmeBX>Sp2z@MdNaVc_84VAxwUk!Kwfklf=B089o4JOBUy diff --git a/docs/type-search-index.zip b/docs/type-search-index.zip index 40ca148e9503e48a37894f915004450322412c32..35baae30080643d035f57eb4c5d6a16b1c3755e1 100644 GIT binary patch delta 28 jcmaFL_LPk$z?+#xgn@&DgQ2-{BM&z-Q*-5HNoF4aVKxSF delta 28 jcmaFL_LPk$z?+#xgn@&DgJEycMjmcvroBazC7FEyWeo<` diff --git a/src/main/java/monero/common/TaskLooper.java b/src/main/java/monero/common/TaskLooper.java index d8261487..ae122b1a 100644 --- 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 index e97bd869..170cd88f 100644 --- 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,8 +510,7 @@ 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 getTxs(String... txHashes); @@ -520,8 +518,7 @@ 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 getTxs(List txHashes);