From bfc428a0daf41d2d43d49290d416f4ae8e7b9ceb Mon Sep 17 00:00:00 2001
From: Andreas Schneider <mail@cynapses.org>
Date: Sat, 18 Apr 2009 16:19:24 +0000
Subject: Change back to a initialized variable and document ssh_finalize().

git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@557 7dcaeef0-15fb-0310-b436-a5af3365683c
---
 libssh/init.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

(limited to 'libssh/init.c')

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);
-- 
cgit