diff options
author | pedroGitt <pedro.contreiras@amdocs.com> | 2016-10-28 10:02:06 +0200 |
---|---|---|
committer | pedroGitt <pedro.contreiras@amdocs.com> | 2016-10-28 10:02:06 +0200 |
commit | 0d3c1a2a46589b004231b92f44d3bc8e327e0097 (patch) | |
tree | 523f1c57cbe583a2025949f2ff5757aa677f0fd8 | |
parent | 724d9ea20b938630b81bbdfe5d0ce36d86cbd09e (diff) |
Fix javadoc header comments
2 files changed, 12 insertions, 12 deletions
diff --git a/java/android/OlmLibSdk/olm-sdk/src/main/java/org/matrix/olm/OlmInboundGroupSession.java b/java/android/OlmLibSdk/olm-sdk/src/main/java/org/matrix/olm/OlmInboundGroupSession.java index 7b3ae6e..f7e1812 100644 --- a/java/android/OlmLibSdk/olm-sdk/src/main/java/org/matrix/olm/OlmInboundGroupSession.java +++ b/java/android/OlmLibSdk/olm-sdk/src/main/java/org/matrix/olm/OlmInboundGroupSession.java @@ -190,8 +190,8 @@ public class OlmInboundGroupSession implements Serializable { } /** - * Return a session as a base64 string.<br> - * The account is serialized and encrypted with aKey. + * Return the current inbound group session as a base64 serialized string.<br> + * The session is serialized and encrypted with aKey. * In case of failure, an error human readable * description is provide in aErrorMsg. * @param aKey encryption key @@ -223,10 +223,10 @@ public class OlmInboundGroupSession implements Serializable { /** - * Loads an account from a pickled base64 string.<br> + * Load an inbound group session from a pickled base64 string.<br> * See {@link #serializeDataWithKey(String, StringBuffer)} - * @param aSerializedData pickled account in a base64 string format - * @param aKey key used to encrypted + * @param aSerializedData pickled inbound group session in a base64 string format + * @param aKey encrypting key used in {@link #serializeDataWithKey(String, StringBuffer)} * @param aErrorMsg error message description * @return true if operation succeed, false otherwise */ @@ -252,8 +252,8 @@ public class OlmInboundGroupSession implements Serializable { } /** * JNI counter part of {@link #initWithSerializedData(String, String, StringBuffer)}. - * @param aSerializedData pickled account in a base64 string format - * @param aKey key used to encrypted + * @param aSerializedData pickled session in a base64 string format + * @param aKey key used to encrypted in {@link #serializeDataWithKey(String, StringBuffer)} * @return null if operation succeed, an error message if operation failed */ private native String initWithSerializedDataJni(String aSerializedData, String aKey); diff --git a/java/android/OlmLibSdk/olm-sdk/src/main/java/org/matrix/olm/OlmOutboundGroupSession.java b/java/android/OlmLibSdk/olm-sdk/src/main/java/org/matrix/olm/OlmOutboundGroupSession.java index 67427a9..8ba3bcb 100644 --- a/java/android/OlmLibSdk/olm-sdk/src/main/java/org/matrix/olm/OlmOutboundGroupSession.java +++ b/java/android/OlmLibSdk/olm-sdk/src/main/java/org/matrix/olm/OlmOutboundGroupSession.java @@ -116,8 +116,8 @@ public class OlmOutboundGroupSession implements Serializable { } /** - * Return a session as a base64 string.<br> - * The account is serialized and encrypted with aKey. + * Return the current outbound group session as a base64 serialized string.<br> + * The session is serialized and encrypted with aKey. * In case of failure, an error human readable * description is provide in aErrorMsg. * @param aKey encryption key @@ -143,10 +143,10 @@ public class OlmOutboundGroupSession implements Serializable { /** - * Loads an account from a pickled base64 string.<br> + * Load an outbound group session from a pickled base64 string.<br> * See {@link #serializeDataWithKey(String, StringBuffer)} - * @param aSerializedData pickled account in a base64 string format - * @param aKey key used to encrypted + * @param aSerializedData pickled outbound group session in a base64 string format + * @param aKey encrypting key used in {@link #serializeDataWithKey(String, StringBuffer)} * @param aErrorMsg error message description * @return true if operation succeed, false otherwise */ |