From 8e703b9974de69c06b5abddfcc746514d8f43788 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Mon, 16 Sep 2013 10:50:25 +0200 Subject: callbacks: Improve the documentation of ssh_threads_get_noop(). BUG: https://red.libssh.org/issues/123 --- include/libssh/callbacks.h | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/include/libssh/callbacks.h b/include/libssh/callbacks.h index 7525b73..e28f9dc 100644 --- a/include/libssh/callbacks.h +++ b/include/libssh/callbacks.h @@ -809,9 +809,13 @@ LIBSSH_API int ssh_threads_set_callbacks(struct ssh_threads_callbacks_struct LIBSSH_API struct ssh_threads_callbacks_struct *ssh_threads_get_pthread(void); /** - * @brief returns a pointer on the noop threads callbacks, to be used with - * ssh_threads_set_callbacks. These callbacks do nothing and are being used by - * default. + * @brief Get the noop threads callbacks structure + * + * This can be used with ssh_threads_set_callbacks. These callbacks do nothing + * and are being used by default. + * + * @return Always returns a valid pointer to the noop callbacks structure. + * * @see ssh_threads_set_callbacks */ LIBSSH_API struct ssh_threads_callbacks_struct *ssh_threads_get_noop(void); -- cgit