diff --git a/include/libssh/callbacks.h b/include/libssh/callbacks.h index b97522f4..d0c24fd9 100644 --- a/include/libssh/callbacks.h +++ b/include/libssh/callbacks.h @@ -83,7 +83,7 @@ typedef void (*ssh_log_callback) (ssh_session session, int priority, * * @param function The function name calling the logging functions. * - * @param message The actual message + * @param buffer The actual message * * @param userdata Userdata to be passed to the callback function. */ @@ -117,6 +117,8 @@ typedef void (*ssh_global_request_callback) (ssh_session session, * sends back an X11 connection attempt. This is a client-side API * @param session current session handler * @param userdata Userdata to be passed to the callback function. + * @param originator_address IP address of the machine who sent the request + * @param originator_port port number of the machine who sent the request * @returns a valid ssh_channel handle if the request is to be allowed * @returns NULL if the request should not be allowed * @warning The channel pointer returned by this callback must be closed by the application. @@ -625,6 +627,7 @@ typedef void (*ssh_channel_signal_callback) (ssh_session session, * @brief SSH channel exit status callback. Called when a channel has received an exit status * @param session Current session handler * @param channel the actual channel + * @param exit_status Exit status of the ran command * @param userdata Userdata to be passed to the callback function. */ typedef void (*ssh_channel_exit_status_callback) (ssh_session session, @@ -652,12 +655,13 @@ typedef void (*ssh_channel_exit_signal_callback) (ssh_session session, /** * @brief SSH channel PTY request from a client. + * @param session the session * @param channel the channel * @param term The type of terminal emulation * @param width width of the terminal, in characters * @param height height of the terminal, in characters * @param pxwidth width of the terminal, in pixels - * @param pxheight height of the terminal, in pixels + * @param pwheight height of the terminal, in pixels * @param userdata Userdata to be passed to the callback function. * @returns 0 if the pty request is accepted * @returns -1 if the request is denied @@ -671,6 +675,7 @@ typedef int (*ssh_channel_pty_request_callback) (ssh_session session, /** * @brief SSH channel Shell request from a client. + * @param session the session * @param channel the channel * @param userdata Userdata to be passed to the callback function. * @returns 0 if the shell request is accepted @@ -683,6 +688,7 @@ typedef int (*ssh_channel_shell_request_callback) (ssh_session session, * @brief SSH auth-agent-request from the client. This request is * sent by a client when agent forwarding is available. * Server is free to ignore this callback, no answer is expected. + * @param session the session * @param channel the channel * @param userdata Userdata to be passed to the callback function. */ @@ -694,7 +700,12 @@ typedef void (*ssh_channel_auth_agent_req_callback) (ssh_session session, * @brief SSH X11 request from the client. This request is * sent by a client when X11 forwarding is requested(and available). * Server is free to ignore this callback, no answer is expected. + * @param session the session * @param channel the channel + * @param single_connection If true, only one channel should be forwarded + * @param auth_protocol The X11 authentication method to be used + * @param auth_cookie Authentication cookie encoded hexadecimal + * @param screen_number Screen number * @param userdata Userdata to be passed to the callback function. */ typedef void (*ssh_channel_x11_req_callback) (ssh_session session, @@ -706,11 +717,12 @@ typedef void (*ssh_channel_x11_req_callback) (ssh_session session, void *userdata); /** * @brief SSH channel PTY windows change (terminal size) from a client. + * @param session the session * @param channel the channel * @param width width of the terminal, in characters * @param height height of the terminal, in characters * @param pxwidth width of the terminal, in pixels - * @param pxheight height of the terminal, in pixels + * @param pwheight height of the terminal, in pixels * @param userdata Userdata to be passed to the callback function. * @returns 0 if the pty request is accepted * @returns -1 if the request is denied @@ -723,6 +735,7 @@ typedef int (*ssh_channel_pty_window_change_callback) (ssh_session session, /** * @brief SSH channel Exec request from a client. + * @param session the session * @param channel the channel * @param command the shell command to be executed * @param userdata Userdata to be passed to the callback function. @@ -736,6 +749,7 @@ typedef int (*ssh_channel_exec_request_callback) (ssh_session session, /** * @brief SSH channel environment request from a client. + * @param session the session * @param channel the channel * @param env_name name of the environment value to be set * @param env_value value of the environment value to be set @@ -752,6 +766,7 @@ typedef int (*ssh_channel_env_request_callback) (ssh_session session, void *userdata); /** * @brief SSH channel subsystem request from a client. + * @param session the session * @param channel the channel * @param subsystem the subsystem required * @param userdata Userdata to be passed to the callback function. @@ -766,6 +781,8 @@ typedef int (*ssh_channel_subsystem_request_callback) (ssh_session session, /** * @brief SSH channel write will not block (flow control). * + * @param session the session + * * @param channel the channel * * @param[in] bytes size of the remote window in bytes. Writing as much data diff --git a/src/agent.c b/src/agent.c index bb4d35a6..6e3d7d79 100644 --- a/src/agent.c +++ b/src/agent.c @@ -160,7 +160,11 @@ static void agent_set_channel(struct ssh_agent_struct *agent, ssh_channel channe * The SSH agent channel will be used to authenticate this client using * an agent through a channel, from another session. The most likely use * is to implement SSH Agent forwarding into a SSH proxy. + * + * @param session the session + * * @param[in] channel a SSH channel from another session. + * * @returns SSH_OK in case of success * SSH_ERROR in case of an error */ diff --git a/src/channels.c b/src/channels.c index 4c6972cb..f2fe39aa 100644 --- a/src/channels.c +++ b/src/channels.c @@ -3811,4 +3811,4 @@ error: #endif -/* @} */ +/** @} */ diff --git a/src/client.c b/src/client.c index 32206081..faf7e7a1 100644 --- a/src/client.c +++ b/src/client.c @@ -731,7 +731,7 @@ ssh_session_set_disconnect_message(ssh_session session, const char *message) * The session can then be reused to open a new session. * * @note Note that this function won't close the socket if it was set with - * @ssh_options_set and SSH_OPTIONS_FD. You're responsible for closing the + * ssh_options_set and SSH_OPTIONS_FD. You're responsible for closing the * socket. This is new behavior in libssh 0.10. * * @param[in] session The SSH session to use. diff --git a/src/pki.c b/src/pki.c index b723cc93..a7c84c5e 100644 --- a/src/pki.c +++ b/src/pki.c @@ -229,6 +229,8 @@ enum ssh_keytypes_e ssh_key_type(const ssh_key key) * * @param[in] type The algorithm type to convert. * + * @param[in] hash_type The hash type to convert + * * @return A string for the keytype or NULL if unknown. */ const char * diff --git a/src/server.c b/src/server.c index 7e2fbfc1..3658780e 100644 --- a/src/server.c +++ b/src/server.c @@ -1217,7 +1217,7 @@ int ssh_execute_message_callbacks(ssh_session session){ /** * @brief Sends a keepalive message to the session * - * @param The session to send the message to + * @param session The session to send the message to * * @returns SSH_OK */ diff --git a/src/socket.c b/src/socket.c index 41e4858b..7d44c8c5 100644 --- a/src/socket.c +++ b/src/socket.c @@ -239,7 +239,7 @@ void ssh_socket_set_connected(ssh_socket s, struct ssh_poll_handle_struct *p) * @param p Poll object this callback belongs to. * @param fd The raw socket. * @param revents The current poll events on the socket. - * @param userdata Userdata to be passed to the callback function, + * @param v_s Userdata to be passed to the callback function, * in this case the socket object. * * @return 0 on success, < 0 when the poll object has been removed