[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] r33591 - gnunet/src/include
|
From: |
gnunet |
|
Subject: |
[GNUnet-SVN] r33591 - gnunet/src/include |
|
Date: |
Sat, 7 Jun 2014 20:37:09 +0200 |
Author: grothoff
Date: 2014-06-07 20:37:09 +0200 (Sat, 07 Jun 2014)
New Revision: 33591
Modified:
gnunet/src/include/gnunet_common.h
gnunet/src/include/gnunet_network_lib.h
Log:
-indent, doxygen
Modified: gnunet/src/include/gnunet_common.h
===================================================================
--- gnunet/src/include/gnunet_common.h 2014-06-07 18:29:16 UTC (rev 33590)
+++ gnunet/src/include/gnunet_common.h 2014-06-07 18:37:09 UTC (rev 33591)
@@ -259,7 +259,9 @@
* #GNUNET_NO to stop iteration with no error,
* #GNUNET_SYSERR to abort iteration with error!
*/
-typedef int (*GNUNET_FileNameCallback) (void *cls, const char *filename);
+typedef int
+(*GNUNET_FileNameCallback) (void *cls,
+ const char *filename);
/* ****************************** logging ***************************** */
@@ -291,8 +293,10 @@
* @param date when was the message logged?
* @param message what is the message
*/
-typedef void (*GNUNET_Logger) (void *cls, enum GNUNET_ErrorType kind,
- const char *component, const char *date,
+typedef void (*GNUNET_Logger) (void *cls,
+ enum GNUNET_ErrorType kind,
+ const char *component,
+ const char *date,
const char *message);
@@ -310,7 +314,8 @@
GNUNET_get_log_call_status (int caller_level,
const char *comp,
const char *file,
- const char *function, int line);
+ const char *function,
+ int line);
#endif
@@ -437,10 +442,11 @@
* Ignore the next @a n calls to the log function.
*
* @param n number of log calls to ignore (could be negative)
- * @param check_reset GNUNET_YES to assert that the log skip counter is
currently zero
+ * @param check_reset #GNUNET_YES to assert that the log skip counter is
currently zero
*/
void
-GNUNET_log_skip (int n, int check_reset);
+GNUNET_log_skip (int n,
+ int check_reset);
/**
@@ -453,7 +459,9 @@
* @return #GNUNET_OK on success, #GNUNET_SYSERR if logfile could not be opened
*/
int
-GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile);
+GNUNET_log_setup (const char *comp,
+ const char *loglevel,
+ const char *logfile);
/**
@@ -464,7 +472,8 @@
* @param logger_cls closure for @a logger
*/
void
-GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
+GNUNET_logger_add (GNUNET_Logger logger,
+ void *logger_cls);
/**
@@ -472,10 +481,11 @@
* Remove a custom logger.
*
* @param logger log function
- * @param logger_cls closure for logger
+ * @param logger_cls closure for @a logger
*/
void
-GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
+GNUNET_logger_remove (GNUNET_Logger logger,
+ void *logger_cls);
/**
@@ -513,7 +523,7 @@
*
* @param pid the peer identity
* @return string form of the pid; will be overwritten by next
- * call to #GNUNET_i2s.
+ * call to #GNUNET_i2s().
*/
const char *
GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
@@ -527,7 +537,7 @@
*
* @param pid the peer identity
* @return string form of the pid; will be overwritten by next
- * call to #GNUNET_i2s.
+ * call to #GNUNET_i2s_full().
*/
const char *
GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid);
@@ -540,12 +550,13 @@
* in the entire API that is NOT reentrant!
*
* @param addr the address
- * @param addrlen the length of the address
+ * @param addrlen the length of the @a addr
* @return nicely formatted string for the address
- * will be overwritten by next call to GNUNET_a2s.
+ * will be overwritten by next call to #GNUNET_a2s().
*/
const char *
-GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen);
+GNUNET_a2s (const struct sockaddr *addr,
+ socklen_t addrlen);
/**
Modified: gnunet/src/include/gnunet_network_lib.h
===================================================================
--- gnunet/src/include/gnunet_network_lib.h 2014-06-07 18:29:16 UTC (rev
33590)
+++ gnunet/src/include/gnunet_network_lib.h 2014-06-07 18:37:09 UTC (rev
33591)
@@ -167,7 +167,7 @@
*
* @param desc socket to connect
* @param address peer address
- * @param address_len of address
+ * @param address_len of @a address
* @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
*/
int
@@ -188,8 +188,10 @@
*/
int
GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,
- int level, int optname, void *optval,
- socklen_t * optlen);
+ int level,
+ int optname,
+ void *optval,
+ socklen_t *optlen);
/**
@@ -211,8 +213,7 @@
* @returns #GNUNET_NO if no data is available, or on error!
*/
ssize_t
-GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle
- *desc);
+GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle
*desc);
/**
@@ -227,8 +228,10 @@
*/
ssize_t
GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc,
- void *buffer, size_t length,
- struct sockaddr *src_addr, socklen_t *addrlen);
+ void *buffer,
+ size_t length,
+ struct sockaddr *src_addr,
+ socklen_t *addrlen);
/**
@@ -241,11 +244,13 @@
*/
ssize_t
GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc,
- void *buffer, size_t length);
+ void *buffer,
+ size_t length);
/**
- * Check if sockets meet certain conditions
+ * Check if sockets meet certain conditions.
+ *
* @param rfds set of sockets to be checked for readability
* @param wfds set of sockets to be checked for writability
* @param efds set of sockets to be checked for exceptions
@@ -269,7 +274,8 @@
*/
ssize_t
GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc,
- const void *buffer, size_t length);
+ const void *buffer,
+ size_t length);
/**
@@ -278,14 +284,15 @@
*
* @param desc socket
* @param message data to send
- * @param length size of the data
+ * @param length size of the data in @a message
* @param dest_addr destination address
- * @param dest_len length of address
+ * @param dest_len length of @a dest_addr
* @return number of bytes sent, #GNUNET_SYSERR on error
*/
ssize_t
GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc,
- const void *message, size_t length,
+ const void *message,
+ size_t length,
const struct sockaddr *dest_addr,
socklen_t dest_len);
@@ -297,12 +304,14 @@
* @param level protocol level of the option
* @param option_name option identifier
* @param option_value value to set
- * @param option_len size of option_value
+ * @param option_len size of @a option_value
* @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
*/
int
-GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd, int level,
- int option_name, const void *option_value,
+GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd,
+ int level,
+ int option_name,
+ const void *option_value,
socklen_t option_len);
@@ -314,7 +323,8 @@
* @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
*/
int
-GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, int how);
+GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc,
+ int how);
/**
@@ -341,7 +351,9 @@
* @return new socket, NULL on error
*/
struct GNUNET_NETWORK_Handle *
-GNUNET_NETWORK_socket_create (int domain, int type, int protocol);
+GNUNET_NETWORK_socket_create (int domain,
+ int type,
+ int protocol);
/**
@@ -372,7 +384,7 @@
* @param h the file handle to add
*/
void
-GNUNET_NETWORK_fdset_handle_set_native_w32_handle (struct GNUNET_NETWORK_FDSet
*fds
+GNUNET_NETWORK_fdset_handle_set_native_w32_handle (struct GNUNET_NETWORK_FDSet
*fds,
HANDLE h);
#endif
@@ -450,7 +462,8 @@
*/
void
GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,
- const fd_set *from, int nfds);
+ const fd_set *from,
+ int nfds);
/**
@@ -460,7 +473,8 @@
* @param nfd native FD to set
*/
void
-GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to, int nfd);
+GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to,
+ int nfd);
/**
@@ -468,7 +482,7 @@
*
* @param to set to test, NULL for empty set
* @param nfd native FD to test, -1 for none
- * @return GNUNET_YES if to contains nfd
+ * @return #GNUNET_YES if to contains nfd
*/
int
GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to,
@@ -488,6 +502,7 @@
/**
* Check if a file handle is part of an fd set
+ *
* @param fds fd set
* @param h file handle
* @return #GNUNET_YES if the file handle is part of the set
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] r33591 - gnunet/src/include,
gnunet <=