From b3cece27d66dd89350a4d854e307e61bdc40bdf2 Mon Sep 17 00:00:00 2001
From: Moxie Marlinspike <moxie@thoughtcrime.org>
Date: Sun, 20 Jul 2014 15:22:50 -0700
Subject: [PATCH] Update SessionCipher javadocs.

---
 .../libaxolotl/SessionCipher.java             | 23 ++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

diff --git a/libaxolotl/src/main/java/org/whispersystems/libaxolotl/SessionCipher.java b/libaxolotl/src/main/java/org/whispersystems/libaxolotl/SessionCipher.java
index a146266f9f..2a70a80951 100644
--- a/libaxolotl/src/main/java/org/whispersystems/libaxolotl/SessionCipher.java
+++ b/libaxolotl/src/main/java/org/whispersystems/libaxolotl/SessionCipher.java
@@ -124,6 +124,21 @@ public class SessionCipher {
     }
   }
 
+  /**
+   * Decrypt a message.
+   *
+   * @param  ciphertext The {@link PreKeyWhisperMessage} to decrypt.
+   * @return The plaintext.
+   * @throws InvalidMessageException if the input is not valid ciphertext.
+   * @throws DuplicateMessageException if the input is a message that has already been received.
+   * @throws LegacyMessageException if the input is a message formatted by a protocol version that
+   *                                is no longer supported.
+   * @throws InvalidKeyIdException when there is no local {@link org.whispersystems.libaxolotl.state.PreKeyRecord}
+   *                               that corresponds to the PreKey ID in the message.
+   * @throws InvalidKeyException when the message is formatted incorrectly.
+   * @throws UntrustedIdentityException when the {@link IdentityKey} of the sender is untrusted.
+
+   */
   public byte[] decrypt(PreKeyWhisperMessage ciphertext)
       throws DuplicateMessageException, LegacyMessageException, InvalidMessageException,
              InvalidKeyIdException, InvalidKeyException, UntrustedIdentityException, NoSessionException
@@ -147,16 +162,18 @@ public class SessionCipher {
   /**
    * Decrypt a message.
    *
-   * @param  ciphertext The ciphertext message bytes corresponding to a serialized
-   *                    {@link WhisperMessage}.
+   * @param  ciphertext The {@link WhisperMessage} to decrypt.
+   *
    * @return The plaintext.
    * @throws InvalidMessageException if the input is not valid ciphertext.
    * @throws DuplicateMessageException if the input is a message that has already been received.
    * @throws LegacyMessageException if the input is a message formatted by a protocol version that
    *                                is no longer supported.
+   * @throws NoSessionException if there is no established session for this contact.
    */
   public byte[] decrypt(WhisperMessage ciphertext)
-      throws InvalidMessageException, DuplicateMessageException, LegacyMessageException, NoSessionException
+      throws InvalidMessageException, DuplicateMessageException, LegacyMessageException,
+             NoSessionException
   {
     synchronized (SESSION_LOCK) {