aboutsummaryrefslogtreecommitdiff
path: root/libssh/init.c
diff options
context:
space:
mode:
authorAndreas Schneider <mail@cynapses.org>2009-04-18 16:19:24 +0000
committerAndreas Schneider <mail@cynapses.org>2009-04-18 16:19:24 +0000
commitbfc428a0daf41d2d43d49290d416f4ae8e7b9ceb (patch)
tree35e8b784efd9962f3f672a2a95258cdaf79b4b86 /libssh/init.c
parent44924db3e91b8d080d3f288582411c042dd3add4 (diff)
downloadlibssh-bfc428a0daf41d2d43d49290d416f4ae8e7b9ceb.tar.gz
libssh-bfc428a0daf41d2d43d49290d416f4ae8e7b9ceb.tar.xz
libssh-bfc428a0daf41d2d43d49290d416f4ae8e7b9ceb.zip
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
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 6b10033..158151b 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);