aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYounes Serraj <younes.serraj@gmail.com>2016-01-24 18:34:15 +0100
committerAndreas Schneider <asn@cryptomilk.org>2016-02-23 08:15:24 +0100
commita69a1af56857ef2bd570db75b970a73c96e35e69 (patch)
tree519fa4a9cdcd1582a4580fb6ce60b410353a5ade
parent32b72555eee588d526adc54f4a810bebec265b34 (diff)
downloadlibssh-a69a1af56857ef2bd570db75b970a73c96e35e69.tar.gz
libssh-a69a1af56857ef2bd570db75b970a73c96e35e69.tar.xz
libssh-a69a1af56857ef2bd570db75b970a73c96e35e69.zip
pki: Fixed documentation about return value.
Documentation now is congruent with the code: - SSH_OK is returned on success, - SSH_ERROR is returned on error. Signed-off-by: Younes Serraj <younes.serraj@gmail.com> Reviewed-by: Andreas Schneider <asn@samba.org> (cherry picked from commit 66c6ae1a55b83cac8581be1d1a8906a62e327a34)
-rw-r--r--src/pki.c2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/pki.c b/src/pki.c
index cac5057b..5b26579d 100644
--- a/src/pki.c
+++ b/src/pki.c
@@ -1094,7 +1094,7 @@ error:
* @param[out] pkey A pointer to store the newly allocated public key. You
* NEED to free the key.
*
- * @return A public key, NULL on error.
+ * @return SSH_OK on success, SSH_ERROR on error.
*
* @see ssh_key_free()
*/