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

More doxygen stuff

Browse Source
This commit is contained in:
Aris Adamantiadis
2009-12-09 20:27:10 +01:00
parent ab52ca01ad
commit ab6b510408
2 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
libssh/pcap.c
View File

@@ -23,6 +23,7 @@
/** \defgroup ssh_pcap SSH-pcap /** \defgroup ssh_pcap SSH-pcap
* \brief libssh pcap file generation * \brief libssh pcap file generation
* *
*
* \addtogroup ssh_pcap * \addtogroup ssh_pcap
* @{ */ * @{ */

20
libssh/socket.c
View File

@@ -72,7 +72,7 @@ static int ssh_socket_unbuffered_read(ssh_socket s, void *buffer, uint32_t len);
static int ssh_socket_unbuffered_write(ssh_socket s, const void *buffer, static int ssh_socket_unbuffered_write(ssh_socket s, const void *buffer,
uint32_t len); uint32_t len);
/* /**
* \internal * \internal
* \brief inits the socket system (windows specific) * \brief inits the socket system (windows specific)
*/ */
@@ -87,7 +87,7 @@ int ssh_socket_init(void) {
#endif #endif
return 0; return 0;
} }
/* /**
* \internal * \internal
* \brief creates a new Socket object * \brief creates a new Socket object
*/ */
@@ -277,7 +277,7 @@ int ssh_socket_unix(ssh_socket s, const char *path) {
} }
#endif #endif
/* \internal /** \internal
* \brief closes a socket * \brief closes a socket
*/ */
void ssh_socket_close(ssh_socket s){ void ssh_socket_close(ssh_socket s){
@@ -293,7 +293,7 @@ void ssh_socket_close(ssh_socket s){
} }
} }
/* \internal /** \internal
* \brief sets the file descriptor of the socket * \brief sets the file descriptor of the socket
*/ */
void ssh_socket_set_fd(ssh_socket s, socket_t fd) { void ssh_socket_set_fd(ssh_socket s, socket_t fd) {
@@ -302,21 +302,21 @@ void ssh_socket_set_fd(ssh_socket s, socket_t fd) {
ssh_poll_set_fd(s->poll,fd); ssh_poll_set_fd(s->poll,fd);
} }
/* \internal /** \internal
* \brief returns the file descriptor of the socket * \brief returns the file descriptor of the socket
*/ */
socket_t ssh_socket_get_fd(ssh_socket s) { socket_t ssh_socket_get_fd(ssh_socket s) {
return s->fd; return s->fd;
} }
/* \internal /** \internal
* \brief returns nonzero if the socket is open * \brief returns nonzero if the socket is open
*/ */
int ssh_socket_is_open(ssh_socket s) { int ssh_socket_is_open(ssh_socket s) {
return s->fd != -1; return s->fd != -1;
} }
/* \internal /** \internal
* \brief read len bytes from socket into buffer * \brief read len bytes from socket into buffer
*/ */
static int ssh_socket_unbuffered_read(ssh_socket s, void *buffer, uint32_t len) { static int ssh_socket_unbuffered_read(ssh_socket s, void *buffer, uint32_t len) {
@@ -341,7 +341,7 @@ static int ssh_socket_unbuffered_read(ssh_socket s, void *buffer, uint32_t len)
return rc; return rc;
} }
/* \internal /** \internal
* \brief writes len bytes from buffer to socket * \brief writes len bytes from buffer to socket
*/ */
static int ssh_socket_unbuffered_write(ssh_socket s, const void *buffer, static int ssh_socket_unbuffered_write(ssh_socket s, const void *buffer,
@@ -370,7 +370,7 @@ static int ssh_socket_unbuffered_write(ssh_socket s, const void *buffer,
return w; return w;
} }
/* \internal /** \internal
* \brief returns nonzero if the current socket is in the fd_set * \brief returns nonzero if the current socket is in the fd_set
*/ */
int ssh_socket_fd_isset(ssh_socket s, fd_set *set) { int ssh_socket_fd_isset(ssh_socket s, fd_set *set) {
@@ -380,7 +380,7 @@ int ssh_socket_fd_isset(ssh_socket s, fd_set *set) {
return FD_ISSET(s->fd,set); return FD_ISSET(s->fd,set);
} }
/* \internal /** \internal
* \brief sets the current fd in a fd_set and updates the fd_max * \brief sets the current fd in a fd_set and updates the fd_max
*/ */