From 27fcc337a3b6484dee8f31773d083f14463bc33f Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit.marty@gmail.com>
Date: Tue, 30 Apr 2019 18:19:26 -0400
Subject: improve some comments

---
 android/olm-sdk/src/main/java/org/matrix/olm/OlmSAS.java | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'android/olm-sdk/src/main/java/org')

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()) {
-- 
cgit v1.2.3