diff options
author | Andreas Schneider <asn@cryptomilk.org> | 2013-09-16 10:50:25 +0200 |
---|---|---|
committer | Andreas Schneider <asn@cryptomilk.org> | 2013-09-16 10:50:25 +0200 |
commit | 8e703b9974de69c06b5abddfcc746514d8f43788 (patch) | |
tree | 204f8674c33736ba68c55cb58e19f8f90b9e381a | |
parent | 89853607c565cdee4638ce2d026d8a5575fa8978 (diff) | |
download | libssh-8e703b9974de69c06b5abddfcc746514d8f43788.tar.gz libssh-8e703b9974de69c06b5abddfcc746514d8f43788.tar.xz libssh-8e703b9974de69c06b5abddfcc746514d8f43788.zip |
callbacks: Improve the documentation of ssh_threads_get_noop().
BUG: https://red.libssh.org/issues/123
-rw-r--r-- | include/libssh/callbacks.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/include/libssh/callbacks.h b/include/libssh/callbacks.h index 7525b73d..e28f9dc4 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); |