1
1

callbacks: Improve the documentation of ssh_threads_set_callbacks().

BUG: https://red.libssh.org/issues/123
Этот коммит содержится в:
Andreas Schneider 2013-09-16 10:54:30 +02:00
родитель 8e703b9974
Коммит 5e2fbbc202

Просмотреть файл

@ -788,12 +788,17 @@ struct ssh_threads_callbacks_struct {
}; };
/** /**
* @brief sets the thread callbacks necessary if your program is using * @brief Set the thread callbacks structure.
* libssh in a multithreaded fashion. This function must be called first, *
* outside of any threading context (in your main() for instance), before * This is necessary if your program is using libssh in a multithreaded fashion.
* ssh_init(). * This function must be called first, outside of any threading context (in your
* @param cb pointer to a ssh_threads_callbacks_struct structure, which contains * main() function for instance), before you call ssh_init().
* the different callbacks to be set. *
* @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_callbacks_struct
* @see SSH_THREADS_PTHREAD * @see SSH_THREADS_PTHREAD
*/ */