summaryrefslogtreecommitdiff
path: root/lib/privkey_raw.c
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2018-11-11 08:52:13 +0100
committerNikos Mavrogiannopoulos <nmav@redhat.com>2018-11-15 13:43:02 +0100
commit74be675bd1d6e4bdf5a0c20f854344da8b87720d (patch)
treef872ee6a1f748f35ee3c3eed90810b87b8184c19 /lib/privkey_raw.c
parent64771f333f223551d76243319af439db13e0b638 (diff)
downloadgnutls-74be675bd1d6e4bdf5a0c20f854344da8b87720d.tar.gz
doc: minor updates in elliptic curve documentation
Signed-off-by: Nikos Mavrogiannopoulos <nmav@gnutls.org>
Diffstat (limited to 'lib/privkey_raw.c')
-rw-r--r--lib/privkey_raw.c28
1 files changed, 14 insertions, 14 deletions
diff --git a/lib/privkey_raw.c b/lib/privkey_raw.c
index 6272964128..0f0187a2c7 100644
--- a/lib/privkey_raw.c
+++ b/lib/privkey_raw.c
@@ -191,8 +191,8 @@ int ret;
* gnutls_privkey_export_ecc_raw:
* @key: Holds the public key
* @curve: will hold the curve
- * @x: will hold the x coordinate
- * @y: will hold the y coordinate
+ * @x: will hold the x-coordinate
+ * @y: will hold the y-coordinate
* @k: will hold the private key
*
* This function will export the ECC private key's parameters found
@@ -220,8 +220,8 @@ gnutls_privkey_export_ecc_raw(gnutls_privkey_t key,
* gnutls_privkey_export_ecc_raw2:
* @key: Holds the public key
* @curve: will hold the curve
- * @x: will hold the x coordinate
- * @y: will hold the y coordinate
+ * @x: will hold the x-coordinate
+ * @y: will hold the y-coordinate
* @k: will hold the private key
* @flags: flags from %gnutls_abstract_export_flags_t
*
@@ -271,8 +271,8 @@ int ret;
* @curve: will hold the curve
* @digest: will hold the digest
* @paramset: will hold the GOST parameter set ID
- * @x: will hold the x coordinate
- * @y: will hold the y coordinate
+ * @x: will hold the x-coordinate
+ * @y: will hold the y-coordinate
* @k: will hold the private key
* @flags: flags from %gnutls_abstract_export_flags_t
*
@@ -429,16 +429,16 @@ error:
* gnutls_privkey_import_ecc_raw:
* @key: The key
* @curve: holds the curve
- * @x: holds the x
- * @y: holds the y
- * @k: holds the k
+ * @x: holds the x-coordinate
+ * @y: holds the y-coordinate
+ * @k: holds the k (private key)
*
* This function will convert the given elliptic curve parameters to the
* native #gnutls_privkey_t format. The output will be stored
* in @key.
*
- * In EdDSA curves the @y parameter should be %NULL and the @x parameter must
- * be the value in the native format for the curve.
+ * In EdDSA curves the @y parameter should be %NULL and the @x and @k parameters
+ * must be in the native format for the curve.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
@@ -484,9 +484,9 @@ error:
* @curve: holds the curve
* @digest: holds the digest
* @paramset: holds the GOST parameter set ID
- * @x: holds the x
- * @y: holds the y
- * @k: holds the k
+ * @x: holds the x-coordinate
+ * @y: holds the y-coordinate
+ * @k: holds the k (private key)
*
* This function will convert the given GOST private key's parameters to the
* native #gnutls_privkey_t format. The output will be stored