Skip to content
Snippets Groups Projects
Commit 0d3c1a2a authored by pedroGitt's avatar pedroGitt
Browse files

Fix javadoc header comments

parent 724d9ea2
No related branches found
No related tags found
No related merge requests found
......@@ -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);
......
......@@ -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
*/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment