diff options
| author | Benoit Marty <benoit.marty@gmail.com> | 2019-04-30 18:19:26 -0400 |
|---|---|---|
| committer | Hubert Chathi <hubert@uhoreg.ca> | 2019-04-30 18:19:26 -0400 |
| commit | 27fcc337a3b6484dee8f31773d083f14463bc33f (patch) | |
| tree | 017296666d40d7b9858c251c770efa2fa1ec6697 /android | |
| parent | 6aafd69f8fdb09ca3b764d5e4a90b12f4be1b8ae (diff) | |
improve some comments
Diffstat (limited to 'android')
| -rw-r--r-- | android/olm-sdk/src/main/java/org/matrix/olm/OlmSAS.java | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/android/olm-sdk/src/main/java/org/matrix/olm/OlmSAS.java b/android/olm-sdk/src/main/java/org/matrix/olm/OlmSAS.java index 4bd1579..a0589e9 100644 --- a/android/olm-sdk/src/main/java/org/matrix/olm/OlmSAS.java +++ b/android/olm-sdk/src/main/java/org/matrix/olm/OlmSAS.java @@ -40,6 +40,8 @@ public class OlmSAS { /** * Gets the Public Key encoded in Base64 with no padding + * @return The public key + * @throws OlmException the failure reason */ public String getPublicKey() throws OlmException { try { @@ -60,7 +62,7 @@ public class OlmSAS { * Sets the public key of other user. * * @param otherPkey other user public key (base64 encoded with no padding) - * @throws OlmException + * @throws OlmException the failure reason */ public void setTheirPublicKey(String otherPkey) throws OlmException { try { @@ -79,7 +81,7 @@ public class OlmSAS { * per the Matrix spec. * @param byteNumber The size of the short code to generate * @return The generated shortcode - * @throws OlmException + * @throws OlmException the failure reason */ public byte[] generateShortCode(String info, int byteNumber) throws OlmException { if (theirPublicKey == null || theirPublicKey.isEmpty()) { |