Documentation improvements

This commit is contained in:
Gilles Peskine 2019-05-14 16:10:53 +02:00
parent 003a4a97d3
commit ac99e32b79
2 changed files with 7 additions and 7 deletions

View file

@ -2497,11 +2497,11 @@ psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
* *
* This function does not require the input to be aligned to any * This function does not require the input to be aligned to any
* particular block boundary. If the implementation can only process * particular block boundary. If the implementation can only process
* a whole block at a time, it must store the last partial input block * a whole block at a time, it must consume all the input provided, but
* or adjust its internal state accordingly until the next call to * it may delay the end of the corresponding output until a subsequent
* psa_aead_update(), psa_aead_finish() or psa_aead_verify(), and produce * call to psa_aead_update(), psa_aead_finish() or psa_aead_verify()
* the corresponding output when sufficient input is available or on the * provides sufficient input. The amount of data that can be delayed
* finish or verify call. * in this way is bounded by #PSA_AEAD_UPDATE_OUTPUT_SIZE.
* *
* \param[in,out] operation Active AEAD operation. * \param[in,out] operation Active AEAD operation.
* \param[in] input Buffer containing the message fragment to * \param[in] input Buffer containing the message fragment to
@ -2628,7 +2628,7 @@ psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
* *
* \param[in,out] operation Active AEAD operation. * \param[in,out] operation Active AEAD operation.
* \param[out] plaintext Buffer where the last part of the plaintext * \param[out] plaintext Buffer where the last part of the plaintext
* is to be written. This is the remaining * is to be written. This is the remaining data
* from previous calls to psa_aead_update() * from previous calls to psa_aead_update()
* that could not be processed until the end * that could not be processed until the end
* of the input. * of the input.

View file

@ -298,7 +298,7 @@
/** A sufficient output buffer size for psa_aead_update(). /** A sufficient output buffer size for psa_aead_update().
* *
* If the size of the output buffer is at least this large, it is * If the size of the output buffer is at least this large, it is
* guaranteed that psa_aead_finish() will not fail due to an * guaranteed that psa_aead_update() will not fail due to an
* insufficient buffer size. The actual size of the output may be smaller * insufficient buffer size. The actual size of the output may be smaller
* in any given call. * in any given call.
* *