aboutsummaryrefslogtreecommitdiff
path: root/libssh/init.c
diff options
context:
space:
mode:
authorAndreas Schneider <mail@cynapses.org>2010-02-05 18:34:39 +0100
committerAndreas Schneider <mail@cynapses.org>2010-02-05 18:34:39 +0100
commit1297da380e0e35989c55ff96c1ecf2e4d10b1e7f (patch)
tree323e0ada6a6ca3e4d621bad9a3e3a5f641d5bd7f /libssh/init.c
parent4ee3b28ecb1edcd7b6b761aecb0e331cf0ad96f1 (diff)
downloadlibssh-1297da380e0e35989c55ff96c1ecf2e4d10b1e7f.tar.gz
libssh-1297da380e0e35989c55ff96c1ecf2e4d10b1e7f.tar.xz
libssh-1297da380e0e35989c55ff96c1ecf2e4d10b1e7f.zip
Improve the session documentation.
Diffstat (limited to 'libssh/init.c')
-rw-r--r--libssh/init.c19
1 files changed, 11 insertions, 8 deletions
diff --git a/libssh/init.c b/libssh/init.c
index 9a584298..ddd56e02 100644
--- a/libssh/init.c
+++ b/libssh/init.c
@@ -31,17 +31,20 @@
#endif
/**
- * \addtogroup ssh_session
+ * @defgroup libssh The libssh API
+ *
+ * This is a library implementing the SSH protocols.
+ *
* @{
*/
/**
- * @brief initialize global cryptographic data structures.
+ * @brief Initialize global cryptographic data structures.
*
* This function should only be called once, at the beginning of the program, in
* the main thread. It may be omitted if your program is not multithreaded.
*
- * @returns 0
+ * @returns 0 on success, -1 if an error occured.
*/
int ssh_init(void) {
if(ssh_crypto_init())
@@ -59,7 +62,8 @@ int ssh_init(void) {
*
* This function should only be called once, at the end of the program!
*
- * @returns -1 in case of error
+ * @returns 0 on succes, -1 if an error occured.
+ *
@returns 0 otherwise
*/
int ssh_finalize(void) {
@@ -77,7 +81,6 @@ int ssh_finalize(void) {
return 0;
}
-/**
- * @}
- */
-/* vim: set ts=2 sw=2 et cindent: */
+/* @} */
+
+/* vim: set ts=4 sw=4 et cindent: */