shinys000114/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2026-02-04 12:20:42 +09:00
Code Issues Packages Projects Releases Wiki Activity

doc: Fixed callbacks documentation.

Browse Source
This commit is contained in:
Andreas Schneider
2011-01-28 13:03:51 +01:00
parent eb49bf4bfd
commit b7db87c817
3 changed files with 898 additions and 656 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1520
doc/doxy.config.in
View File

File diff suppressed because it is too large Load Diff

7
include/libssh/callbacks.h
View File

@@ -33,6 +33,11 @@
extern "C" {
#endif
/**
* @addtogroup ssh_session
* @{
*/
/**
* @brief SSH authentication callback.
*
@@ -110,4 +115,6 @@ LIBSSH_API int ssh_set_callbacks(ssh_session session, ssh_callbacks cb);
}
#endif
/** @} */
#endif /*_SSH_CALLBACK_H */

27
libssh/options.c
View File

@@ -266,33 +266,6 @@ int ssh_options_set_algo(ssh_session session, int algo,
* \n
* See the corresponding numbers in libssh.h.
*
* - SSH_OPTTIONS_AUTH_CALLBACK:
* Set a callback to use your own authentication function
* (function pointer).
*
* - SSH_OPTTIONS_AUTH_USERDATA:
* Set the user data passed to the authentication
* function (generic pointer).
*
* - SSH_OPTTIONS_LOG_CALLBACK:
* Set a callback to use your own logging function
* (function pointer).
*
* - SSH_OPTTIONS_LOG_USERDATA:
* Set the user data passed to the logging function
* (generic pointer).
*
* - SSH_OPTTIONS_STATUS_CALLBACK:
* Set a callback to show connection status in realtime
* (function pointer).\n
* \n
* @code
* fn(void *arg, float status)
* @endcode
* \n
* During ssh_connect(), libssh will call the callback
* with status from 0.0 to 1.0.
*
* - SSH_OPTTIONS_STATUS_ARG:
* Set the status argument which should be passed to the
* status callback (generic pointer).