commit e730bd4b9d68a38b3d4277f6222369de61da8225
parent b4c960a89653aeab4a3ef1f6102623bbb9c92f44
Author: Christian Grothoff <christian@grothoff.org>
Date: Mon, 23 Sep 2013 09:19:19 +0000
-doxygen, style
Diffstat:
4 files changed, 33 insertions(+), 31 deletions(-)
diff --git a/src/dht/gnunet-service-dht_neighbours.c b/src/dht/gnunet-service-dht_neighbours.c
@@ -110,7 +110,7 @@ GNUNET_NETWORK_STRUCT_BEGIN
struct PeerPutMessage
{
/**
- * Type: GNUNET_MESSAGE_TYPE_DHT_P2P_PUT
+ * Type: #GNUNET_MESSAGE_TYPE_DHT_P2P_PUT
*/
struct GNUNET_MessageHeader header;
@@ -167,7 +167,7 @@ struct PeerPutMessage
struct PeerResultMessage
{
/**
- * Type: GNUNET_MESSAGE_TYPE_DHT_P2P_RESULT
+ * Type: #GNUNET_MESSAGE_TYPE_DHT_P2P_RESULT
*/
struct GNUNET_MessageHeader header;
@@ -211,7 +211,7 @@ struct PeerResultMessage
struct PeerGetMessage
{
/**
- * Type: GNUNET_MESSAGE_TYPE_DHT_P2P_GET
+ * Type: #GNUNET_MESSAGE_TYPE_DHT_P2P_GET
*/
struct GNUNET_MessageHeader header;
@@ -1201,10 +1201,10 @@ get_target_peers (const struct GNUNET_HashCode *key,
* @param hop_count how many hops has this message traversed so far
* @param bf Bloom filter of peers this PUT has already traversed
* @param key key for the content
- * @param put_path_length number of entries in put_path
+ * @param put_path_length number of entries in @a put_path
* @param put_path peers this request has traversed so far (if tracked)
* @param data payload to store
- * @param data_size number of bytes in data
+ * @param data_size number of bytes in @a data
*/
void
GDS_NEIGHBOURS_handle_put (enum GNUNET_BLOCK_Type type,
@@ -1213,7 +1213,7 @@ GDS_NEIGHBOURS_handle_put (enum GNUNET_BLOCK_Type type,
struct GNUNET_TIME_Absolute expiration_time,
uint32_t hop_count,
struct GNUNET_CONTAINER_BloomFilter *bf,
- const struct GNUNET_HashCode * key,
+ const struct GNUNET_HashCode *key,
unsigned int put_path_length,
struct GNUNET_PeerIdentity *put_path,
const void *data, size_t data_size)
@@ -1320,9 +1320,9 @@ GDS_NEIGHBOURS_handle_put (enum GNUNET_BLOCK_Type type,
* @param hop_count how many hops did this request traverse so far?
* @param key key for the content
* @param xquery extended query
- * @param xquery_size number of bytes in xquery
+ * @param xquery_size number of bytes in @a xquery
* @param reply_bf bloomfilter to filter duplicates
- * @param reply_bf_mutator mutator for reply_bf
+ * @param reply_bf_mutator mutator for @a reply_bf
* @param peer_bf filter for peers not to select (again)
*/
void
@@ -1434,12 +1434,12 @@ GDS_NEIGHBOURS_handle_get (enum GNUNET_BLOCK_Type type,
* @param type type of the block
* @param expiration_time when does the content expire
* @param key key for the content
- * @param put_path_length number of entries in put_path
+ * @param put_path_length number of entries in @a put_path
* @param put_path peers the original PUT traversed (if tracked)
- * @param get_path_length number of entries in put_path
+ * @param get_path_length number of entries in @a get_path
* @param get_path peers this reply has traversed so far (if tracked)
* @param data payload of the reply
- * @param data_size number of bytes in data
+ * @param data_size number of bytes in @a data
*/
void
GDS_NEIGHBOURS_handle_reply (const struct GNUNET_PeerIdentity *target,
@@ -1535,11 +1535,12 @@ core_init (void *cls,
* @param peer sender of the request
* @param message message
* @param peer peer identity this notification is about
- * @return GNUNET_OK to keep the connection open,
- * GNUNET_SYSERR to close it (signal serious error)
+ * @return #GNUNET_OK to keep the connection open,
+ * #GNUNET_SYSERR to close it (signal serious error)
*/
static int
-handle_dht_p2p_put (void *cls, const struct GNUNET_PeerIdentity *peer,
+handle_dht_p2p_put (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
const struct GNUNET_MessageHeader *message)
{
const struct PeerPutMessage *put;
@@ -1588,7 +1589,8 @@ handle_dht_p2p_put (void *cls, const struct GNUNET_PeerIdentity *peer,
char *tmp;
tmp = GNUNET_strdup (GNUNET_i2s (&my_identity));
- LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "XDHT PUT %s: %s->%s (%u, %u=>%u)\n",
+ LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
+ "XDHT PUT %s: %s->%s (%u, %u=>%u)\n",
GNUNET_h2s (&put->key), GNUNET_i2s (peer), tmp,
ntohl(put->hop_count),
GNUNET_CRYPTO_hash_matching_bits (&peer->hashPubKey, &put->key),
diff --git a/src/dht/gnunet-service-dht_routing.c b/src/dht/gnunet-service-dht_routing.c
@@ -153,11 +153,11 @@ struct ProcessContext
/**
* Forward the result to the given peer if it matches the request.
*
- * @param cls the 'struct ProcessContext' with the result
+ * @param cls the `struct ProcessContext` with the result
* @param key the query
- * @param value the 'struct RecentRequest' with the request
- * @return GNUNET_OK (continue to iterate),
- * GNUNET_SYSERR if the result is malformed or type unsupported
+ * @param value the `struct RecentRequest` with the request
+ * @return #GNUNET_OK (continue to iterate),
+ * #GNUNET_SYSERR if the result is malformed or type unsupported
*/
static int
process (void *cls, const struct GNUNET_HashCode * key, void *value)
@@ -378,10 +378,10 @@ try_combine_recent (void *cls, const struct GNUNET_HashCode * key, void *value)
* @param options options for processing
* @param key key for the content
* @param xquery extended query
- * @param xquery_size number of bytes in xquery
+ * @param xquery_size number of bytes in @a xquery
* @param reply_bf bloomfilter to filter duplicates
- * @param reply_bf_mutator mutator for reply_bf
-*/
+ * @param reply_bf_mutator mutator for @a reply_bf
+ */
void
GDS_ROUTING_add (const struct GNUNET_PeerIdentity *sender,
enum GNUNET_BLOCK_Type type,
diff --git a/src/dht/gnunet-service-dht_routing.h b/src/dht/gnunet-service-dht_routing.h
@@ -41,12 +41,12 @@
* @param type type of the block
* @param expiration_time when does the content expire
* @param key key for the content
- * @param put_path_length number of entries in put_path
+ * @param put_path_length number of entries in @a put_path
* @param put_path peers the original PUT traversed (if tracked)
- * @param get_path_length number of entries in put_path
+ * @param get_path_length number of entries in @a get_path
* @param get_path peers this reply has traversed so far (if tracked)
* @param data payload of the reply
- * @param data_size number of bytes in data
+ * @param data_size number of bytes in @a data
*/
void
GDS_ROUTING_process (enum GNUNET_BLOCK_Type type,
@@ -66,9 +66,9 @@ GDS_ROUTING_process (enum GNUNET_BLOCK_Type type,
* @param options options for processing
* @param key key for the content
* @param xquery extended query
- * @param xquery_size number of bytes in xquery
+ * @param xquery_size number of bytes in @a xquery
* @param reply_bf bloomfilter to filter duplicates
- * @param reply_bf_mutator mutator for reply_bf
+ * @param reply_bf_mutator mutator for @a reply_bf
*/
void
GDS_ROUTING_add (const struct GNUNET_PeerIdentity *sender,
diff --git a/src/gns/gnunet-service-gns_resolver.c b/src/gns/gnunet-service-gns_resolver.c
@@ -1539,15 +1539,15 @@ namestore_cache_continuation (void *cls,
* Iterator called on each result obtained for a DHT
* operation that expects a reply
*
- * @param cls closure with the 'struct GNS_ResolverHandle'
+ * @param cls closure with the `struct GNS_ResolverHandle`
* @param exp when will this value expire
* @param key key of the result
* @param get_path peers on reply path (or NULL if not recorded)
* [0] = datastore's first neighbor, [length - 1] = local peer
- * @param get_path_length number of entries in get_path
+ * @param get_path_length number of entries in @a get_path
* @param put_path peers on the PUT path (or NULL if not recorded)
* [0] = origin, [length - 1] = datastore
- * @param put_path_length number of entries in get_path
+ * @param put_path_length number of entries in @a get_path
* @param type type of the result
* @param size number of bytes in data
* @param data pointer to the result data
@@ -1555,7 +1555,7 @@ namestore_cache_continuation (void *cls,
static void
handle_dht_response (void *cls,
struct GNUNET_TIME_Absolute exp,
- const struct GNUNET_HashCode * key,
+ const struct GNUNET_HashCode *key,
const struct GNUNET_PeerIdentity *get_path,
unsigned int get_path_length,
const struct GNUNET_PeerIdentity *put_path,
