aboutsummaryrefslogtreecommitdiff
path: root/libssh/init.c
diff options
context:
space:
mode:
Diffstat (limited to 'libssh/init.c')
-rw-r--r--libssh/init.c11
1 files changed, 7 insertions, 4 deletions
diff --git a/libssh/init.c b/libssh/init.c
index 6b10033b..158151bf 100644
--- a/libssh/init.c
+++ b/libssh/init.c
@@ -32,12 +32,15 @@
* \addtogroup ssh_session
* @{
*/
+
/**
- * \brief finalize and cleanup all libssh and cryptographic data structures
- * \returns 0
+ * @brief Finalize and cleanup all libssh and cryptographic data structures.
+ *
+ * This function should only be called once, at the end of the program!
+ *
+ * @returns 0
*/
-int ssh_finalize(void)
-{
+int ssh_finalize(void) {
ssh_crypto_finalize();
#ifdef HAVE_LIBGCRYPT
gcry_control(GCRYCTL_TERM_SECMEM);