Skip to content

Commit

Permalink
Fix Sphinx errors [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
randombit committed Aug 3, 2023
1 parent 93a0696 commit 2c748bf
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions doc/api_ref/pubkey.rst
Original file line number Diff line number Diff line change
Expand Up @@ -834,17 +834,17 @@ encapulated key and returns the shared secret.

Size in bytes of the encapsulated key being produced by this PK_KEM_Encryptor.

.. cpp:function:: KEM_Encapsulation encrypt(RandomNumberGenerator& rng,
size_t desired_shared_key_len = 32,
.. cpp:function:: KEM_Encapsulation encrypt(RandomNumberGenerator& rng, \
size_t desired_shared_key_len = 32, \
std::span<const uint8_t> salt = {})

Perform a key encapsulation operation with the result being returned
as a convenient struct.

.. cpp:function:: void encrypt(std::span<uint8_t> out_encapsulated_key,
std::span<uint8_t> out_shared_key,
RandomNumberGenerator& rng,
size_t desired_shared_key_len = 32,
.. cpp:function:: void encrypt(std::span<uint8_t> out_encapsulated_key, \
std::span<uint8_t> out_shared_key, \
RandomNumberGenerator& rng, \
size_t desired_shared_key_len = 32, \
std::span<const uint8_t> salt = {})

Perform a key encapsulation operation by passing in out-buffers of
Expand Down Expand Up @@ -888,9 +888,9 @@ encapulated key and returns the shared secret.

Perform a key decapsulation operation

.. cpp:function:: void decrypt(std::span<uint8_t> out_shared_key,
std::span<const uint8_t> encap_key,
size_t desired_shared_key_len = 32,
.. cpp:function:: void decrypt(std::span<uint8_t> out_shared_key, \
std::span<const uint8_t> encap_key, \
size_t desired_shared_key_len = 32, \
std::span<const uint8_t> salt = {})

Perform a key decapsulation operation by passing in a pre-allocated
Expand Down

0 comments on commit 2c748bf

Please sign in to comment.