lib/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2025-12-02 01:17:52 +03:00
Code Activity

Resolving doxygen errors in internal mode

Browse Source
This commit is contained in:
Aris Adamantiadis
2009-12-09 19:53:58 +01:00
parent 64b72f8d3a
commit ab52ca01ad
2 changed files with 20 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
libssh/messages.c
View File

@@ -850,11 +850,15 @@ void ssh_message_free(ssh_message msg){
SAFE_FREE(msg); SAFE_FREE(msg);
} }
/** \internal /** @internal
* \brief handle various SSH request messages and stack them for callback * @brief handle various SSH request messages and stack them for callback.
* \param session SSH session * @param session SSH session.
* \param type packet type * @param user user provided value.
* \returns nothing * @param type packet type.
* @param packet buffer.
* @return SSH_PACKET_USED if a message has been created.
* @return SSH_PACKET_NOT_USED if the packet could not be used to create a
* message.
*/ */
int message_handle(ssh_session session, void *user, uint8_t type, ssh_buffer packet){ int message_handle(ssh_session session, void *user, uint8_t type, ssh_buffer packet){
ssh_message msg=ssh_message_retrieve(session,type); ssh_message msg=ssh_message_retrieve(session,type);

20
libssh/socket.c
View File

@@ -123,8 +123,9 @@ ssh_socket ssh_socket_new(ssh_session session) {
/** /**
* @internal * @internal
* @brief the socket callbacks, i.e. callbacks to be called * @brief the socket callbacks, i.e. callbacks to be called
* upon a socket event * upon a socket event.
* @param callbacks a ssh_socket_callback object reference * @param s socket to set callbacks on.
* @param callbacks a ssh_socket_callback object reference.
*/ */
void ssh_socket_set_callbacks(ssh_socket s, ssh_socket_callbacks callbacks){ void ssh_socket_set_callbacks(ssh_socket s, ssh_socket_callbacks callbacks){
@@ -770,14 +771,15 @@ int ssh_socket_get_status(ssh_socket s) {
* @internal * @internal
* @brief Launches a socket connection * @brief Launches a socket connection
* If a the socket connected callback has been defined and * If a the socket connected callback has been defined and
* a poll object exists, this call will be non blocking * a poll object exists, this call will be non blocking.
* @param host hostname or ip address to connect to * @param s socket to connect.
* @param port port number to connect to * @param host hostname or ip address to connect to.
* @param bind_addr address to bind to, or NULL for default * @param port port number to connect to.
* @returns SSH_OK socket is being connected * @param bind_addr address to bind to, or NULL for default.
* @returns SSH_ERROR error while connecting to remote host * @returns SSH_OK socket is being connected.
* @returns SSH_ERROR error while connecting to remote host.
* @bug It only tries connecting to one of the available AI's * @bug It only tries connecting to one of the available AI's
* which is problematic for hosts having DNS fail-over * which is problematic for hosts having DNS fail-over.
*/ */
int ssh_socket_connect(ssh_socket s, const char *host, int port, const char *bind_addr){ int ssh_socket_connect(ssh_socket s, const char *host, int port, const char *bind_addr){