From 875273d8a8cec1055c4d5d3f1211b18e9e2b7412 Mon Sep 17 00:00:00 2001 From: Andre Date: Fri, 5 Jan 2007 17:27:26 +0100 Subject: [PATCH] net.c: some documentation fixes --- net.c | 72 ++++++++++++++++++++++++++++++++++------------------------- 1 file changed, 41 insertions(+), 31 deletions(-) diff --git a/net.c b/net.c index 0105ef69..70aacd8c 100644 --- a/net.c +++ b/net.c @@ -78,12 +78,13 @@ void disable_crypt(int fd) /** * initialize a struct sockaddr_in - * @param addr A pointer to the struct to be initialized - * @param port The port number to use - * @param he The address to use * - * If \a he is null (server mode), \a addr->sin_addr is initialized with \p INADDR_ANY. - * Otherwise, the address given by \a he is copied to addr. + * \param addr A pointer to the struct to be initialized + * \param port The port number to use + * \param he The address to use + * + * If \a he is null (server mode), \a addr->sin_addr is initialized with \p + * INADDR_ANY. Otherwise, the address given by \a he is copied to addr. */ void init_sockaddr(struct sockaddr_in *addr, int port, const struct hostent *he) { @@ -101,13 +102,17 @@ void init_sockaddr(struct sockaddr_in *addr, int port, const struct hostent *he) /* * send out a buffer, resend on short writes - * @param fd the file descriptor - * @param buf The buffer to be sent - * @len The length of \a buf + * + * \param fd the file descriptor + * \param buf The buffer to be sent + * \param len The length of \a buf * * Due to circumstances beyond your control, the kernel might not send all the * data out in one chunk, and now, my friend, it's up to us to get the data out * there (Beej's Guide to Network Programming). + * + * \return This function returns 1 on success and \a -E_SEND on errors. The + * number of bytes actually sent is stored upon successful return in \a len. */ static int sendall(int fd, const char *buf, size_t *len) { @@ -131,15 +136,16 @@ static int sendall(int fd, const char *buf, size_t *len) /** * encrypt and send buffer - * @param fd: the file descriptor - * @param buf the buffer to be encrypted and sent - * @param len the length of \a buf + * + * \param fd: the file descriptor + * \param buf the buffer to be encrypted and sent + * \param len the length of \a buf * * Check if encrytpion is available. If yes, encrypt the given buffer. Send out * the buffer, encrypted or not, and try to resend the remaing part in case of * short writes. * - * @return Positive on success, \p -E_SEND on errors. + * \return Positive on success, \p -E_SEND on errors. */ int send_bin_buffer(int fd, const char *buf, size_t len) { @@ -163,12 +169,13 @@ int send_bin_buffer(int fd, const char *buf, size_t len) /** * encrypt and send null terminated buffer. - * @param fd the file descriptor - * @param buf the null-terminated buffer to be send + * + * \param fd the file descriptor + * \param buf the null-terminated buffer to be send * * This is equivalent to send_bin_buffer(fd, buf, strlen(buf)). * - * @return Positive on success, \p -E_SEND on errors. + * \return Positive on success, \p -E_SEND on errors. */ int send_buffer(int fd, const char *buf) { @@ -178,10 +185,11 @@ int send_buffer(int fd, const char *buf) /** * send and encrypt a buffer given by a format string - * @param fd the file descriptor - * @param fmt a format string * - * @return Positive on success, \p -E_SEND on errors. + * \param fd the file descriptor + * \param fmt a format string + * + * \return Positive on success, \p -E_SEND on errors. */ __printf_2_3 int send_va_buffer(int fd, const char *fmt, ...) { @@ -197,16 +205,17 @@ __printf_2_3 int send_va_buffer(int fd, const char *fmt, ...) /** * receive and decrypt. * - * @param fd the file descriptor - * @param buf the buffer to write the decrypted data to - * @param size the size of @param buf + * \param fd the file descriptor + * \param buf the buffer to write the decrypted data to + * \param size the size of \a buf * * Receive at most \a size bytes from filedescriptor fd. If encryption is * available, decrypt the received buffer. * - * @return the number of bytes received on success. On receive errors, -E_RECV + * \return the number of bytes received on success. On receive errors, -E_RECV * is returned. On crypt errors, the corresponding crypt error number is * returned. + * * \sa recv(2) */ __must_check int recv_bin_buffer(int fd, char *buf, ssize_t size) @@ -233,12 +242,12 @@ __must_check int recv_bin_buffer(int fd, char *buf, ssize_t size) /** * receive, decrypt and write terminating NULL byte * - * @param fd the file descriptor - * @param buf the buffer to write the decrypted data to - * @param size the size of \a buf + * \param fd the file descriptor + * \param buf the buffer to write the decrypted data to + * \param size the size of \a buf * - * Read and decrypt at most size - 1 bytes from file descriptor \a fd and write - * a NULL byte at the end of the received data. + * Read and decrypt at most \a size - 1 bytes from file descriptor \a fd and + * write a NULL byte at the end of the received data. * */ int recv_buffer(int fd, char *buf, ssize_t size) @@ -278,7 +287,8 @@ int get_host_info(char *host, struct hostent **ret) * Create an IPv4 socket for sequenced, reliable, two-way, connection-based * byte streams. * - * @return The socket fd on success, -E_SOCKET on errors. + * \return The socket fd on success, -E_SOCKET on errors. + * * \sa socket(2) */ int get_socket(void) @@ -293,10 +303,10 @@ int get_socket(void) /** * a wrapper around connect(2) * - * @param fd the file descriptor - * @param their_addr the address to connect + * \param fd the file descriptor + * \param their_addr the address to connect * - * @return \p -E_CONNECT on errors, 1 on success + * \return \p -E_CONNECT on errors, 1 on success * \sa connect(2) */ int para_connect(int fd, struct sockaddr_in *their_addr) -- 2.30.2