From 5e2fbbc202aab30a4e345406ba5ae5344a53d078 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Mon, 16 Sep 2013 10:54:30 +0200 Subject: [PATCH] callbacks: Improve the documentation of ssh_threads_set_callbacks(). BUG: https://red.libssh.org/issues/123 --- include/libssh/callbacks.h | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/include/libssh/callbacks.h b/include/libssh/callbacks.h index e28f9dc4..131e8229 100644 --- a/include/libssh/callbacks.h +++ b/include/libssh/callbacks.h @@ -788,12 +788,17 @@ struct ssh_threads_callbacks_struct { }; /** - * @brief sets the thread callbacks necessary if your program is using - * libssh in a multithreaded fashion. This function must be called first, - * outside of any threading context (in your main() for instance), before - * ssh_init(). - * @param cb pointer to a ssh_threads_callbacks_struct structure, which contains - * the different callbacks to be set. + * @brief Set the thread callbacks structure. + * + * This is necessary if your program is using libssh in a multithreaded fashion. + * This function must be called first, outside of any threading context (in your + * main() function for instance), before you call ssh_init(). + * + * @param[in] cb A pointer to a ssh_threads_callbacks_struct structure, which + * contains the different callbacks to be set. + * + * @returns Always returns SSH_OK. + * * @see ssh_threads_callbacks_struct * @see SSH_THREADS_PTHREAD */