Skip to content

Commit 9a46883

Browse files
committed
java: Clean up javadoc issues
1 parent 54a302d commit 9a46883

File tree

4 files changed

+14
-16
lines changed

4 files changed

+14
-16
lines changed

java/client/src/main/java/org/signal/libsignal/cds2/Cds2Client.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
/**
1717
* Cds2Client provides bindings to interact with Signal's v2 Contact Discovery Service.
1818
*
19-
* <p>{@inheritDoc}
19+
* <p>See the {@link SgxClient} docs for more information.
2020
*
2121
* <p>A future update to Cds2Client will implement additional parts of the contact discovery
2222
* protocol.

java/client/src/main/java/org/signal/libsignal/net/KeyTransparencyClient.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,10 @@ public class KeyTransparencyClient {
7272
* <ul>
7373
* <li>{@link ChatServiceException} for errors related to communication with the server.
7474
* Depending on the severity, the search can be retried.
75-
* <li>{@link KeyTransparencyException} for errors related to key transparency logic, which
76-
* includes missing required fields in the serialized data. Retrying the search without
77-
* changing any of the arguments (including the state of the store) is unlikely to yield a
78-
* different result.
75+
* <li>{@link org.signal.libsignal.keytrans.KeyTransparencyException} for errors related to key
76+
* transparency logic, which includes missing required fields in the serialized data.
77+
* Retrying the search without changing any of the arguments (including the state of the
78+
* store) is unlikely to yield a different result.
7979
* <li>{@link org.signal.libsignal.keytrans.VerificationFailedException} indicates a failure to
8080
* verify the data in key transparency server response, such as an incorrect proof or a
8181
* wrong signature.
@@ -147,9 +147,9 @@ public CompletableFuture<Void> search(
147147
* <ul>
148148
* <li>{@link ChatServiceException} for errors related to communication with the server.
149149
* Depending on the severity, the request can be retried.
150-
* <li>{@link KeyTransparencyException} for the errors related to key transparency logic.
151-
* Retrying the search without changing any of the arguments (including the state of the
152-
* store) is unlikely to produce a different result.
150+
* <li>{@link org.signal.libsignal.keytrans.KeyTransparencyException} for errors related to key
151+
* transparency logic. Retrying the search without changing any of the arguments (including
152+
* the state of the store) is unlikely to yield a different result.
153153
* </ul>
154154
*
155155
* @param store local persistent storage for key transparency related data, such as the latest
@@ -201,10 +201,10 @@ public CompletableFuture<Void> updateDistinguished(final Store store) {
201201
* <ul>
202202
* <li>{@link ChatServiceException} for errors related to communication with the server.
203203
* Depending on the severity, the search can be retried.
204-
* <li>{@link KeyTransparencyException} for errors related to key transparency logic, which
205-
* includes missing required fields in the serialized data. Retrying the search without
206-
* changing any of the arguments (including the state of the store) is unlikely to yield a
207-
* different result.
204+
* <li>{@link org.signal.libsignal.keytrans.KeyTransparencyException} for errors related to key
205+
* transparency logic, which includes missing required fields in the serialized data.
206+
* Retrying the search without changing any of the arguments (including the state of the
207+
* store) is unlikely to yield a different result.
208208
* <li>{@link org.signal.libsignal.keytrans.VerificationFailedException} indicates a failure to
209209
* verify the data in key transparency server response, such as an incorrect proof or a
210210
* wrong signature.

java/client/src/main/java/org/signal/libsignal/svr2/Svr2Client.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@
1616
/**
1717
* Svr2Client provides bindings to interact with Signal's v2 Secure Value Recovery service.
1818
*
19-
* <p>
20-
*
21-
* <p>{@inheritDoc}
19+
* <p>See the {@link SgxClient} docs for more information.
2220
*/
2321
public class Svr2Client extends SgxClient {
2422
public Svr2Client(byte[] mrenclave, byte[] attestationMsg, Instant currentInstant)

java/shared/java/org/signal/libsignal/protocol/SignalProtocolAddress.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public SignalProtocolAddress(String name, int deviceId) {
2121
}
2222

2323
/**
24-
* @param name the identifier for the recipient
24+
* @param serviceId the identifier for the recipient
2525
* @param deviceId the identifier for the device; must be in the range 1-127 inclusive
2626
*/
2727
public SignalProtocolAddress(ServiceId serviceId, int deviceId) {

0 commit comments

Comments
 (0)