summaryrefslogtreecommitdiff
path: root/toxencryptsave
diff options
context:
space:
mode:
authorZetok Zalbavar <zexavexxe@gmail.com>2016-12-16 11:32:09 +0000
committerZetok Zalbavar <zexavexxe@gmail.com>2016-12-17 19:45:43 +0000
commit4733f849faa1c982cf15f8893e2371794efbc90f (patch)
tree9d604c0933ae7cac98c38bab1673f88fac01ab40 /toxencryptsave
parentb0647b174c324740ca3b80695b9cde5afd83b891 (diff)
docs(TES): correct docs to reflect how many bytes fns actually require
Diffstat (limited to 'toxencryptsave')
-rw-r--r--toxencryptsave/toxencryptsave.api.h8
-rw-r--r--toxencryptsave/toxencryptsave.h8
2 files changed, 8 insertions, 8 deletions
diff --git a/toxencryptsave/toxencryptsave.api.h b/toxencryptsave/toxencryptsave.api.h
index 93456235..b0e29b50 100644
--- a/toxencryptsave/toxencryptsave.api.h
+++ b/toxencryptsave/toxencryptsave.api.h
@@ -145,7 +145,7 @@ error for decryption {
145 * ${pass_Key.encrypt}. 145 * ${pass_Key.encrypt}.
146 * 146 *
147 * @param plaintext A byte array of length `plaintext_len`. 147 * @param plaintext A byte array of length `plaintext_len`.
148 * @param plaintext_len The length of the plain text array. May be 0. 148 * @param plaintext_len The length of the plain text array. Bigger than 0.
149 * @param passphrase The user-provided password. 149 * @param passphrase The user-provided password.
150 * @param passphrase_len The length of the password. 150 * @param passphrase_len The length of the password.
151 * @param ciphertext The cipher text array to write the encrypted data to. 151 * @param ciphertext The cipher text array to write the encrypted data to.
@@ -163,7 +163,7 @@ static bool pass_encrypt(const uint8_t[plaintext_len] plaintext, const uint8_t[p
163 * bytes long. This delegates to ${pass_Key.decrypt}. 163 * bytes long. This delegates to ${pass_Key.decrypt}.
164 * 164 *
165 * @param ciphertext A byte array of length `ciphertext_len`. 165 * @param ciphertext A byte array of length `ciphertext_len`.
166 * @param ciphertext_len The length of the cipher text array. May be 0. 166 * @param ciphertext_len The length of the cipher text array. At least $PASS_ENCRYPTION_EXTRA_LENGTH.
167 * @param passphrase The user-provided password. 167 * @param passphrase The user-provided password.
168 * @param passphrase_len The length of the password. 168 * @param passphrase_len The length of the password.
169 * @param plaintext The plain text array to write the decrypted data to. 169 * @param plaintext The plain text array to write the decrypted data to.
@@ -246,7 +246,7 @@ class pass_Key {
246 * bytes long. 246 * bytes long.
247 * 247 *
248 * @param plaintext A byte array of length `plaintext_len`. 248 * @param plaintext A byte array of length `plaintext_len`.
249 * @param plaintext_len The length of the plain text array. May be 0. 249 * @param plaintext_len The length of the plain text array. Bigger than 0.
250 * @param ciphertext The cipher text array to write the encrypted data to. 250 * @param ciphertext The cipher text array to write the encrypted data to.
251 * 251 *
252 * @return true on success. 252 * @return true on success.
@@ -259,7 +259,7 @@ class pass_Key {
259 * $derive or $derive_with_salt. 259 * $derive or $derive_with_salt.
260 * 260 *
261 * @param ciphertext A byte array of length `ciphertext_len`. 261 * @param ciphertext A byte array of length `ciphertext_len`.
262 * @param ciphertext_len The length of the cipher text array. May be 0. 262 * @param ciphertext_len The length of the cipher text array. At least $PASS_ENCRYPTION_EXTRA_LENGTH.
263 * @param plaintext The plain text array to write the decrypted data to. 263 * @param plaintext The plain text array to write the decrypted data to.
264 * 264 *
265 * @return true on success. 265 * @return true on success.
diff --git a/toxencryptsave/toxencryptsave.h b/toxencryptsave/toxencryptsave.h
index de53273e..d03383e9 100644
--- a/toxencryptsave/toxencryptsave.h
+++ b/toxencryptsave/toxencryptsave.h
@@ -194,7 +194,7 @@ typedef enum TOX_ERR_DECRYPTION {
194 * tox_pass_key_encrypt. 194 * tox_pass_key_encrypt.
195 * 195 *
196 * @param plaintext A byte array of length `plaintext_len`. 196 * @param plaintext A byte array of length `plaintext_len`.
197 * @param plaintext_len The length of the plain text array. May be 0. 197 * @param plaintext_len The length of the plain text array. Bigger than 0.
198 * @param passphrase The user-provided password. 198 * @param passphrase The user-provided password.
199 * @param passphrase_len The length of the password. 199 * @param passphrase_len The length of the password.
200 * @param ciphertext The cipher text array to write the encrypted data to. 200 * @param ciphertext The cipher text array to write the encrypted data to.
@@ -211,7 +211,7 @@ bool tox_pass_encrypt(const uint8_t *plaintext, size_t plaintext_len, const uint
211 * bytes long. This delegates to tox_pass_key_decrypt. 211 * bytes long. This delegates to tox_pass_key_decrypt.
212 * 212 *
213 * @param ciphertext A byte array of length `ciphertext_len`. 213 * @param ciphertext A byte array of length `ciphertext_len`.
214 * @param ciphertext_len The length of the cipher text array. May be 0. 214 * @param ciphertext_len The length of the cipher text array. At least TOX_PASS_ENCRYPTION_EXTRA_LENGTH.
215 * @param passphrase The user-provided password. 215 * @param passphrase The user-provided password.
216 * @param passphrase_len The length of the password. 216 * @param passphrase_len The length of the password.
217 * @param plaintext The plain text array to write the decrypted data to. 217 * @param plaintext The plain text array to write the decrypted data to.
@@ -298,7 +298,7 @@ bool tox_pass_key_derive_with_salt(struct Tox_Pass_Key *_key, const uint8_t *pas
298 * bytes long. 298 * bytes long.
299 * 299 *
300 * @param plaintext A byte array of length `plaintext_len`. 300 * @param plaintext A byte array of length `plaintext_len`.
301 * @param plaintext_len The length of the plain text array. May be 0. 301 * @param plaintext_len The length of the plain text array. Bigger than 0.
302 * @param ciphertext The cipher text array to write the encrypted data to. 302 * @param ciphertext The cipher text array to write the encrypted data to.
303 * 303 *
304 * @return true on success. 304 * @return true on success.
@@ -311,7 +311,7 @@ bool tox_pass_key_encrypt(const struct Tox_Pass_Key *_key, const uint8_t *plaint
311 * tox_pass_key_derive or tox_pass_key_derive_with_salt. 311 * tox_pass_key_derive or tox_pass_key_derive_with_salt.
312 * 312 *
313 * @param ciphertext A byte array of length `ciphertext_len`. 313 * @param ciphertext A byte array of length `ciphertext_len`.
314 * @param ciphertext_len The length of the cipher text array. May be 0. 314 * @param ciphertext_len The length of the cipher text array. At least TOX_PASS_ENCRYPTION_EXTRA_LENGTH.
315 * @param plaintext The plain text array to write the decrypted data to. 315 * @param plaintext The plain text array to write the decrypted data to.
316 * 316 *
317 * @return true on success. 317 * @return true on success.