From ab6b5104089242dcdb5fa2bd4fac1766be6dfd36 Mon Sep 17 00:00:00 2001 From: Aris Adamantiadis Date: Wed, 9 Dec 2009 20:27:10 +0100 Subject: [PATCH] More doxygen stuff --- libssh/pcap.c | 1 + libssh/socket.c | 20 ++++++++++---------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/libssh/pcap.c b/libssh/pcap.c index a9b00539..8a4d5a40 100644 --- a/libssh/pcap.c +++ b/libssh/pcap.c @@ -23,6 +23,7 @@ /** \defgroup ssh_pcap SSH-pcap * \brief libssh pcap file generation * + * * \addtogroup ssh_pcap * @{ */ diff --git a/libssh/socket.c b/libssh/socket.c index d5df4c39..93e76a0d 100644 --- a/libssh/socket.c +++ b/libssh/socket.c @@ -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, uint32_t len); -/* +/** * \internal * \brief inits the socket system (windows specific) */ @@ -87,7 +87,7 @@ int ssh_socket_init(void) { #endif return 0; } -/* +/** * \internal * \brief creates a new Socket object */ @@ -277,7 +277,7 @@ int ssh_socket_unix(ssh_socket s, const char *path) { } #endif -/* \internal +/** \internal * \brief closes a socket */ 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 */ 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); } -/* \internal +/** \internal * \brief returns the file descriptor of the socket */ socket_t ssh_socket_get_fd(ssh_socket s) { return s->fd; } -/* \internal +/** \internal * \brief returns nonzero if the socket is open */ int ssh_socket_is_open(ssh_socket s) { return s->fd != -1; } -/* \internal +/** \internal * \brief read len bytes from socket into buffer */ 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; } -/* \internal +/** \internal * \brief writes len bytes from buffer to socket */ 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; } -/* \internal +/** \internal * \brief returns nonzero if the current socket is in the fd_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); } -/* \internal +/** \internal * \brief sets the current fd in a fd_set and updates the fd_max */