From 6032b5839d20bc85f6106e5786afc4043b6a1ec3 Mon Sep 17 00:00:00 2001 From: Jesper Louis Andersen Date: Thu, 16 Jan 2020 13:47:41 +0100 Subject: [PATCH] Provide documentation --- src/enacl.erl | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/enacl.erl b/src/enacl.erl index 3dde78d..5071578 100644 --- a/src/enacl.erl +++ b/src/enacl.erl @@ -1005,7 +1005,9 @@ crypto_sign_ed25519_keypair() -> {PK, SK} = enacl_nif:crypto_sign_ed25519_keypair(), #{ public => PK, secret => SK }. -%% @doc TODO +%% @doc crypto_sign_ed25519_sk_to_pk/1 derives an ed25519 public key from a secret key +%% The ed25519 signatures secret keys contains enough information to dervice its corresponding +%% public key. This function extracts the public key from the secret if needed. %% @end -spec crypto_sign_ed25519_sk_to_pk(Secret :: binary()) -> binary(). crypto_sign_ed25519_sk_to_pk(Secret) ->