timoreo/olm
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix javadoc header comments

Browse source
This commit is contained in:
pedroGitt 2016-10-28 10:02:06 +02:00
parent 724d9ea20b
commit 0d3c1a2a46
2 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
java/android/OlmLibSdk/olm-sdk/src/main/java/org/matrix/olm/OlmInboundGroupSession.java
View file

@ -190,8 +190,8 @@ public class OlmInboundGroupSession implements Serializable {
} }
/** /**
* Return a session as a base64 string.<br> * Return the current inbound group session as a base64 serialized string.<br>
* The account is serialized and encrypted with aKey. * The session is serialized and encrypted with aKey.
* In case of failure, an error human readable * In case of failure, an error human readable
* description is provide in aErrorMsg. * description is provide in aErrorMsg.
* @param aKey encryption key * @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)} * See {@link #serializeDataWithKey(String, StringBuffer)}
* @param aSerializedData pickled account in a base64 string format * @param aSerializedData pickled inbound group session in a base64 string format
* @param aKey key used to encrypted * @param aKey encrypting key used in {@link #serializeDataWithKey(String, StringBuffer)}
* @param aErrorMsg error message description * @param aErrorMsg error message description
* @return true if operation succeed, false otherwise * @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)}. * JNI counter part of {@link #initWithSerializedData(String, String, StringBuffer)}.
* @param aSerializedData pickled account in a base64 string format * @param aSerializedData pickled session in a base64 string format
* @param aKey key used to encrypted * @param aKey key used to encrypted in {@link #serializeDataWithKey(String, StringBuffer)}
* @return null if operation succeed, an error message if operation failed * @return null if operation succeed, an error message if operation failed
*/ */
private native String initWithSerializedDataJni(String aSerializedData, String aKey); private native String initWithSerializedDataJni(String aSerializedData, String aKey);

10
java/android/OlmLibSdk/olm-sdk/src/main/java/org/matrix/olm/OlmOutboundGroupSession.java
View file

@ -116,8 +116,8 @@ public class OlmOutboundGroupSession implements Serializable {
} }
/** /**
* Return a session as a base64 string.<br> * Return the current outbound group session as a base64 serialized string.<br>
* The account is serialized and encrypted with aKey. * The session is serialized and encrypted with aKey.
* In case of failure, an error human readable * In case of failure, an error human readable
* description is provide in aErrorMsg. * description is provide in aErrorMsg.
* @param aKey encryption key * @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)} * See {@link #serializeDataWithKey(String, StringBuffer)}
* @param aSerializedData pickled account in a base64 string format * @param aSerializedData pickled outbound group session in a base64 string format
* @param aKey key used to encrypted * @param aKey encrypting key used in {@link #serializeDataWithKey(String, StringBuffer)}
* @param aErrorMsg error message description * @param aErrorMsg error message description
* @return true if operation succeed, false otherwise * @return true if operation succeed, false otherwise
*/ */