aboutsummaryrefslogtreecommitdiff
path: root/src
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:12:34 +0100
commit66c6ae1a55b83cac8581be1d1a8906a62e327a34 (patch)
tree4267d32de81e2feb009031e652df26a76fbbd8ce /src
parent1bc4176d657e772e29c0f4f903b5447bafd24ef0 (diff)
downloadlibssh-66c6ae1a55b83cac8581be1d1a8906a62e327a34.tar.gz
libssh-66c6ae1a55b83cac8581be1d1a8906a62e327a34.tar.xz
libssh-66c6ae1a55b83cac8581be1d1a8906a62e327a34.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>
Diffstat (limited to 'src')
-rw-r--r--src/pki.c2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/pki.c b/src/pki.c
index d15c32cf..0ed3fa71 100644
--- a/src/pki.c
+++ b/src/pki.c
@@ -1222,7 +1222,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()
*/