diff options
Diffstat (limited to 'src/include')
52 files changed, 191 insertions, 126 deletions
diff --git a/src/include/block_dns.h b/src/include/block_dns.h index 2186cb1a1..2c573fb20 100644 --- a/src/include/block_dns.h +++ b/src/include/block_dns.h | |||
@@ -19,6 +19,9 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @addtogroup vpn_suite | ||
23 | * @{ | ||
24 | * | ||
22 | * @author Christian Grothoff | 25 | * @author Christian Grothoff |
23 | * | 26 | * |
24 | * @file | 27 | * @file |
@@ -65,3 +68,5 @@ GNUNET_NETWORK_STRUCT_END | |||
65 | #endif | 68 | #endif |
66 | 69 | ||
67 | /** @} */ /* end of group */ | 70 | /** @} */ /* end of group */ |
71 | |||
72 | /** @} */ /* end of group addition to vpn_suite */ | ||
diff --git a/src/include/block_fs.h b/src/include/block_fs.h index e4caf6e50..f05bb4a29 100644 --- a/src/include/block_fs.h +++ b/src/include/block_fs.h | |||
@@ -19,6 +19,9 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @addtogroup fs_l2 | ||
23 | * @{ | ||
24 | * | ||
22 | * @author Christian Grothoff | 25 | * @author Christian Grothoff |
23 | * | 26 | * |
24 | * @file | 27 | * @file |
@@ -98,3 +101,5 @@ GNUNET_NETWORK_STRUCT_END | |||
98 | #endif | 101 | #endif |
99 | 102 | ||
100 | /** @} */ /* end of group */ | 103 | /** @} */ /* end of group */ |
104 | |||
105 | /** @} */ /* end of group addition to fs_l2 */ | ||
diff --git a/src/include/gnunet_abd_service.h b/src/include/gnunet_abd_service.h index 21f668a8d..a52ed29ff 100644 --- a/src/include/gnunet_abd_service.h +++ b/src/include/gnunet_abd_service.h | |||
@@ -19,13 +19,16 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @addtogroup reclaim_suite | ||
23 | * @{ | ||
24 | * | ||
22 | * @author Martin Schanzenbach | 25 | * @author Martin Schanzenbach |
23 | * | 26 | * |
24 | * @file | 27 | * @file |
25 | * API to the Credential service | 28 | * API to the Credential service |
26 | * | 29 | * |
27 | * @defgroup abd Credential service | 30 | * @defgroup abd Credential service |
28 | * Credentials | 31 | * Credential service for Attribute-Based Decryption |
29 | * | 32 | * |
30 | * @{ | 33 | * @{ |
31 | */ | 34 | */ |
@@ -384,7 +387,7 @@ GNUNET_ABD_remove_delegation (struct GNUNET_ABD_Handle *handle, | |||
384 | * | 387 | * |
385 | * @param issuer the ego that should be used to issue the attribute | 388 | * @param issuer the ego that should be used to issue the attribute |
386 | * @param subject the subject of the attribute | 389 | * @param subject the subject of the attribute |
387 | * @param attribute the name of the attribute | 390 | * @param iss_attr the name of the attribute |
388 | * @param expiration the TTL of the credential | 391 | * @param expiration the TTL of the credential |
389 | * @return handle to the queued request | 392 | * @return handle to the queued request |
390 | */ | 393 | */ |
@@ -415,3 +418,5 @@ GNUNET_ABD_request_cancel (struct GNUNET_ABD_Request *lr); | |||
415 | #endif | 418 | #endif |
416 | 419 | ||
417 | /** @} */ /* end of group */ | 420 | /** @} */ /* end of group */ |
421 | |||
422 | /** @} */ /* end of group addition to reclaim_suite */ | ||
diff --git a/src/include/gnunet_applications.h b/src/include/gnunet_applications.h index 1e2ac59f7..489dc7050 100644 --- a/src/include/gnunet_applications.h +++ b/src/include/gnunet_applications.h | |||
@@ -19,6 +19,9 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @addtogroup Backbone | ||
23 | * @{ | ||
24 | * | ||
22 | * @author Christian Grothoff | 25 | * @author Christian Grothoff |
23 | * | 26 | * |
24 | * @file | 27 | * @file |
@@ -133,4 +136,6 @@ extern "C" | |||
133 | 136 | ||
134 | /** @} */ /* end of group */ | 137 | /** @} */ /* end of group */ |
135 | 138 | ||
139 | /** @} */ /* end of group addition to Backbone */ | ||
140 | |||
136 | /* end of gnunet_applications.h */ | 141 | /* end of gnunet_applications.h */ |
diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h index 11a65c4f5..321e621d2 100644 --- a/src/include/gnunet_ats_service.h +++ b/src/include/gnunet_ats_service.h | |||
@@ -158,7 +158,7 @@ struct GNUNET_ATS_PropertiesNBO | |||
158 | /** | 158 | /** |
159 | * Convert ATS properties from host to network byte order. | 159 | * Convert ATS properties from host to network byte order. |
160 | * | 160 | * |
161 | * @param nbo[OUT] value written | 161 | * @param nbo[out] value written |
162 | * @param hbo value read | 162 | * @param hbo value read |
163 | */ | 163 | */ |
164 | void | 164 | void |
@@ -169,7 +169,7 @@ GNUNET_ATS_properties_hton (struct GNUNET_ATS_PropertiesNBO *nbo, | |||
169 | /** | 169 | /** |
170 | * Convert ATS properties from network to host byte order. | 170 | * Convert ATS properties from network to host byte order. |
171 | * | 171 | * |
172 | * @param hbo[OUT] value written | 172 | * @param hbo[out] value written |
173 | * @param nbo value read | 173 | * @param nbo value read |
174 | */ | 174 | */ |
175 | void | 175 | void |
@@ -344,7 +344,7 @@ GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar, | |||
344 | * @param session session handle | 344 | * @param session session handle |
345 | * @return #GNUNET_YES if the @a ar was destroyed because | 345 | * @return #GNUNET_YES if the @a ar was destroyed because |
346 | * it was an incoming address, | 346 | * it was an incoming address, |
347 | * #GNUNET_NO if the @ar was kept because we can | 347 | * #GNUNET_NO if the @a ar was kept because we can |
348 | * use it still to establish a new session | 348 | * use it still to establish a new session |
349 | */ | 349 | */ |
350 | int | 350 | int |
diff --git a/src/include/gnunet_block_group_lib.h b/src/include/gnunet_block_group_lib.h index d242ceefb..53827f5f4 100644 --- a/src/include/gnunet_block_group_lib.h +++ b/src/include/gnunet_block_group_lib.h | |||
@@ -90,7 +90,7 @@ GNUNET_BLOCK_GROUP_bf_create (void *cls, | |||
90 | * @param bg block group to use for testing | 90 | * @param bg block group to use for testing |
91 | * @param hc hash of element to evaluate | 91 | * @param hc hash of element to evaluate |
92 | * @return #GNUNET_YES if @a hc is (likely) a duplicate | 92 | * @return #GNUNET_YES if @a hc is (likely) a duplicate |
93 | * #GNUNET_NO if @a hc was definitively not in @bg (but now is) | 93 | * #GNUNET_NO if @a hc was definitively not in @a bg (but now is) |
94 | */ | 94 | */ |
95 | enum GNUNET_GenericReturnValue | 95 | enum GNUNET_GenericReturnValue |
96 | GNUNET_BLOCK_GROUP_bf_test_and_set (struct GNUNET_BLOCK_Group *bg, | 96 | GNUNET_BLOCK_GROUP_bf_test_and_set (struct GNUNET_BLOCK_Group *bg, |
diff --git a/src/include/gnunet_block_lib.h b/src/include/gnunet_block_lib.h index fe6c99613..6a6de712b 100644 --- a/src/include/gnunet_block_lib.h +++ b/src/include/gnunet_block_lib.h | |||
@@ -131,7 +131,6 @@ struct GNUNET_BLOCK_Group; | |||
131 | * | 131 | * |
132 | * @param ctx block context in which the block group is created | 132 | * @param ctx block context in which the block group is created |
133 | * @param type type of the block for which we are creating the group | 133 | * @param type type of the block for which we are creating the group |
134 | * @param nonce random value used to seed the group creation | ||
135 | * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh | 134 | * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh |
136 | * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh | 135 | * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh |
137 | * @param ... type-specific additional data, can be empty | 136 | * @param ... type-specific additional data, can be empty |
@@ -272,7 +271,7 @@ GNUNET_BLOCK_group_set_seen (struct GNUNET_BLOCK_Group *bg, | |||
272 | 271 | ||
273 | /** | 272 | /** |
274 | * Try merging two block groups. Afterwards, @a bg1 should remain | 273 | * Try merging two block groups. Afterwards, @a bg1 should remain |
275 | * valid and contain the rules from both @a bg1 and @bg2, and | 274 | * valid and contain the rules from both @a bg1 and @a bg2, and |
276 | * @a bg2 should be destroyed (as part of this call). The latter | 275 | * @a bg2 should be destroyed (as part of this call). The latter |
277 | * should happen even if merging is not supported. | 276 | * should happen even if merging is not supported. |
278 | * | 277 | * |
diff --git a/src/include/gnunet_client_lib.h b/src/include/gnunet_client_lib.h index 3cafa7e45..321810eb4 100644 --- a/src/include/gnunet_client_lib.h +++ b/src/include/gnunet_client_lib.h | |||
@@ -101,8 +101,8 @@ GNUNET_CLIENT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, | |||
101 | 101 | ||
102 | /** @} */ /* end of group client */ | 102 | /** @} */ /* end of group client */ |
103 | 103 | ||
104 | /* @} */ /* end of group addition */ | 104 | /** @} */ /* end of group addition */ |
105 | 105 | ||
106 | /* @} */ /* end of group addition */ | 106 | /** @} */ /* end of group addition */ |
107 | 107 | ||
108 | /* end of gnunet_client_lib.h */ | 108 | /* end of gnunet_client_lib.h */ |
diff --git a/src/include/gnunet_common.h b/src/include/gnunet_common.h index 5035d6baa..8c58fd6e3 100644 --- a/src/include/gnunet_common.h +++ b/src/include/gnunet_common.h | |||
@@ -1510,7 +1510,7 @@ GNUNET_is_zero_ (const void *a, | |||
1510 | * will be updated to reflect the new address. The TYPE of | 1510 | * will be updated to reflect the new address. The TYPE of |
1511 | * arr is important since size is the number of elements and | 1511 | * arr is important since size is the number of elements and |
1512 | * not the size in bytes | 1512 | * not the size in bytes |
1513 | * @param len the number of elements in the existing vector (number | 1513 | * @param len2 the number of elements in the existing vector (number |
1514 | * of elements to copy over), will be updated with the new | 1514 | * of elements to copy over), will be updated with the new |
1515 | * array size | 1515 | * array size |
1516 | 1516 | ||
@@ -1743,7 +1743,7 @@ GNUNET_copy_message (const struct GNUNET_MessageHeader *msg); | |||
1743 | * Set the async scope for the current thread. | 1743 | * Set the async scope for the current thread. |
1744 | * | 1744 | * |
1745 | * @param aid the async scope identifier | 1745 | * @param aid the async scope identifier |
1746 | * @param old_scope[out] location to save the old scope | 1746 | * @param[out] old_scope location to save the old scope |
1747 | */ | 1747 | */ |
1748 | void | 1748 | void |
1749 | GNUNET_async_scope_enter (const struct GNUNET_AsyncScopeId *aid, | 1749 | GNUNET_async_scope_enter (const struct GNUNET_AsyncScopeId *aid, |
diff --git a/src/include/gnunet_configuration_lib.h b/src/include/gnunet_configuration_lib.h index ac0013e94..2d26f3c05 100644 --- a/src/include/gnunet_configuration_lib.h +++ b/src/include/gnunet_configuration_lib.h | |||
@@ -174,7 +174,7 @@ GNUNET_CONFIGURATION_serialize_diagnostics ( | |||
174 | * @param mem the memory block of serialized configuration | 174 | * @param mem the memory block of serialized configuration |
175 | * @param size the size of the memory block | 175 | * @param size the size of the memory block |
176 | * @param source_filename source filename, will be used | 176 | * @param source_filename source filename, will be used |
177 | * to resolve relative @INLINE@ statements | 177 | * to resolve relative \@INLINE\@ statements |
178 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error | 178 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
179 | */ | 179 | */ |
180 | enum GNUNET_GenericReturnValue | 180 | enum GNUNET_GenericReturnValue |
diff --git a/src/include/gnunet_container_lib.h b/src/include/gnunet_container_lib.h index 097ee040d..b31a95fac 100644 --- a/src/include/gnunet_container_lib.h +++ b/src/include/gnunet_container_lib.h | |||
@@ -28,24 +28,30 @@ | |||
28 | * | 28 | * |
29 | * @file | 29 | * @file |
30 | * Container classes for GNUnet | 30 | * Container classes for GNUnet |
31 | * | 31 | * |
32 | * @defgroup hashmap Container library: MultiHashMap | 32 | * @addtogroup container |
33 | * Common data structures in GNUnet programs | ||
34 | * @{ | ||
35 | * | ||
36 | * @defgroup hashmap MultiHashMap | ||
33 | * Hash map with multiple values per key. | 37 | * Hash map with multiple values per key. |
34 | * | 38 | * |
35 | * @see [Documentation](https://gnunet.org/util_multihashmap) | 39 | * @see [Documentation](https://gnunet.org/util_multihashmap) |
36 | * | 40 | * |
37 | * @defgroup heap Container library: Heap | 41 | * @defgroup heap Heap |
38 | * Min- or max-heap with arbitrary element removal | 42 | * Min- or max-heap with arbitrary element removal |
39 | * | 43 | * |
40 | * @defgroup bloomfilter Container library: Bloom filter | 44 | * @defgroup bloomfilter Bloom filter |
41 | * Probabilistic set tests | 45 | * Probabilistic set tests |
42 | * | 46 | * |
43 | * @defgroup dll Container library: Doubly-linked list | 47 | * @defgroup dll Doubly-linked list |
44 | * | 48 | * |
45 | * @see [Documentation](https://gnunet.org/mdll-api) | 49 | * @see [Documentation](https://gnunet.org/mdll-api) |
46 | * | 50 | * |
47 | * @defgroup metadata Container library: Metadata | 51 | * @defgroup metadata Metadata |
48 | * GNU libextractor key-value pairs | 52 | * GNU libextractor key-value pairs |
53 | * | ||
54 | * @} | ||
49 | */ | 55 | */ |
50 | 56 | ||
51 | #ifndef GNUNET_CONTAINER_LIB_H | 57 | #ifndef GNUNET_CONTAINER_LIB_H |
diff --git a/src/include/gnunet_crypto_lib.h b/src/include/gnunet_crypto_lib.h index 7ff50dda1..36e6743b3 100644 --- a/src/include/gnunet_crypto_lib.h +++ b/src/include/gnunet_crypto_lib.h | |||
@@ -1431,7 +1431,7 @@ enum GNUNET_GenericReturnValue | |||
1431 | GNUNET_CRYPTO_eddsa_private_key_from_string ( | 1431 | GNUNET_CRYPTO_eddsa_private_key_from_string ( |
1432 | const char *enc, | 1432 | const char *enc, |
1433 | size_t enclen, | 1433 | size_t enclen, |
1434 | struct GNUNET_CRYPTO_EddsaPrivateKey *pub); | 1434 | struct GNUNET_CRYPTO_EddsaPrivateKey *priv); |
1435 | 1435 | ||
1436 | 1436 | ||
1437 | /** | 1437 | /** |
@@ -1683,7 +1683,7 @@ GNUNET_CRYPTO_ecc_dlog_prepare (unsigned int max, | |||
1683 | * Calculate ECC discrete logarithm for small factors. | 1683 | * Calculate ECC discrete logarithm for small factors. |
1684 | * Opposite of #GNUNET_CRYPTO_ecc_dexp(). | 1684 | * Opposite of #GNUNET_CRYPTO_ecc_dexp(). |
1685 | * | 1685 | * |
1686 | * @param dlc precalculated values, determine range of factors | 1686 | * @param edc precalculated values, determine range of factors |
1687 | * @param input point on the curve to factor | 1687 | * @param input point on the curve to factor |
1688 | * @return INT_MAX if dlog failed, otherwise the factor | 1688 | * @return INT_MAX if dlog failed, otherwise the factor |
1689 | */ | 1689 | */ |
@@ -1954,7 +1954,7 @@ GNUNET_CRYPTO_ecdsa_sign_ ( | |||
1954 | * | 1954 | * |
1955 | * @param priv | 1955 | * @param priv |
1956 | * @param data | 1956 | * @param data |
1957 | * @param len | 1957 | * @param size |
1958 | * @param sig | 1958 | * @param sig |
1959 | * @return enum GNUNET_GenericReturnValue | 1959 | * @return enum GNUNET_GenericReturnValue |
1960 | */ | 1960 | */ |
@@ -2239,7 +2239,7 @@ GNUNET_CRYPTO_ecdsa_public_key_derive ( | |||
2239 | * @param label label to use for key deriviation | 2239 | * @param label label to use for key deriviation |
2240 | * @param context additional context to use for HKDF of 'h'; | 2240 | * @param context additional context to use for HKDF of 'h'; |
2241 | * typically the name of the subsystem/application | 2241 | * typically the name of the subsystem/application |
2242 | * @param purp the signature purpose | 2242 | * @param purpose the signature purpose |
2243 | * @param sig the resulting signature | 2243 | * @param sig the resulting signature |
2244 | * @return GNUNET_OK on success | 2244 | * @return GNUNET_OK on success |
2245 | */ | 2245 | */ |
@@ -2304,7 +2304,7 @@ GNUNET_CRYPTO_eddsa_public_key_derive ( | |||
2304 | * @param label label to use for key deriviation | 2304 | * @param label label to use for key deriviation |
2305 | * @param context additional context to use for HKDF of 'h'; | 2305 | * @param context additional context to use for HKDF of 'h'; |
2306 | * typically the name of the subsystem/application | 2306 | * typically the name of the subsystem/application |
2307 | * @param purp the signature purpose | 2307 | * @param purpose the signature purpose |
2308 | * @param sig the resulting signature | 2308 | * @param sig the resulting signature |
2309 | * @return GNUNET_OK on success | 2309 | * @return GNUNET_OK on success |
2310 | */ | 2310 | */ |
@@ -2432,7 +2432,7 @@ GNUNET_CRYPTO_paillier_encrypt ( | |||
2432 | * @param private_key Private key to use for decryption. | 2432 | * @param private_key Private key to use for decryption. |
2433 | * @param public_key Public key to use for decryption. | 2433 | * @param public_key Public key to use for decryption. |
2434 | * @param ciphertext Ciphertext to decrypt. | 2434 | * @param ciphertext Ciphertext to decrypt. |
2435 | * @param[out] m Decryption of @a ciphertext with @private_key. | 2435 | * @param[out] m Decryption of @a ciphertext with @a private_key. |
2436 | */ | 2436 | */ |
2437 | void | 2437 | void |
2438 | GNUNET_CRYPTO_paillier_decrypt ( | 2438 | GNUNET_CRYPTO_paillier_decrypt ( |
@@ -2690,7 +2690,7 @@ GNUNET_CRYPTO_rsa_public_key_cmp (const struct GNUNET_CRYPTO_RsaPublicKey *p1, | |||
2690 | * Blinds the given message with the given blinding key | 2690 | * Blinds the given message with the given blinding key |
2691 | * | 2691 | * |
2692 | * @param hash hash of the message to sign | 2692 | * @param hash hash of the message to sign |
2693 | * @param bkey the blinding key | 2693 | * @param bks the blinding key |
2694 | * @param pkey the public key of the signer | 2694 | * @param pkey the public key of the signer |
2695 | * @param[out] buf set to a buffer with the blinded message to be signed | 2695 | * @param[out] buf set to a buffer with the blinded message to be signed |
2696 | * @param[out] buf_size number of bytes stored in @a buf | 2696 | * @param[out] buf_size number of bytes stored in @a buf |
diff --git a/src/include/gnunet_curl_lib.h b/src/include/gnunet_curl_lib.h index b5d62ba0f..92334887d 100644 --- a/src/include/gnunet_curl_lib.h +++ b/src/include/gnunet_curl_lib.h | |||
@@ -18,6 +18,9 @@ | |||
18 | SPDX-License-Identifier: AGPL3.0-or-later | 18 | SPDX-License-Identifier: AGPL3.0-or-later |
19 | */ | 19 | */ |
20 | /** | 20 | /** |
21 | * @addtogroup lib_extra Additional libraries | ||
22 | * @{ | ||
23 | * | ||
21 | * @file src/include/gnunet_curl_lib.h | 24 | * @file src/include/gnunet_curl_lib.h |
22 | * @brief library to make it easy to download JSON replies over HTTP | 25 | * @brief library to make it easy to download JSON replies over HTTP |
23 | * @author Sree Harsha Totakura <sreeharsha@totakura.in> | 26 | * @author Sree Harsha Totakura <sreeharsha@totakura.in> |
@@ -224,7 +227,7 @@ typedef void | |||
224 | * be executed AND cleaned up | 227 | * be executed AND cleaned up |
225 | * @param jcc callback to invoke upon completion | 228 | * @param jcc callback to invoke upon completion |
226 | * @param jcc_cls closure for @a jcc | 229 | * @param jcc_cls closure for @a jcc |
227 | * @return NULL on error (in this case, @eh is still released!) | 230 | * @return NULL on error (in this case, @a eh is still released!) |
228 | */ | 231 | */ |
229 | struct GNUNET_CURL_Job * | 232 | struct GNUNET_CURL_Job * |
230 | GNUNET_CURL_job_add (struct GNUNET_CURL_Context *ctx, | 233 | GNUNET_CURL_job_add (struct GNUNET_CURL_Context *ctx, |
@@ -246,7 +249,7 @@ GNUNET_CURL_job_add (struct GNUNET_CURL_Context *ctx, | |||
246 | * be executed AND cleaned up | 249 | * be executed AND cleaned up |
247 | * @param jcc callback to invoke upon completion | 250 | * @param jcc callback to invoke upon completion |
248 | * @param jcc_cls closure for @a jcc | 251 | * @param jcc_cls closure for @a jcc |
249 | * @return NULL on error (in this case, @eh is still released!) | 252 | * @return NULL on error (in this case, @a eh is still released!) |
250 | */ | 253 | */ |
251 | struct GNUNET_CURL_Job * | 254 | struct GNUNET_CURL_Job * |
252 | GNUNET_CURL_job_add_with_ct_json (struct GNUNET_CURL_Context *ctx, | 255 | GNUNET_CURL_job_add_with_ct_json (struct GNUNET_CURL_Context *ctx, |
@@ -304,7 +307,7 @@ GNUNET_CURL_set_tlscert (struct GNUNET_CURL_Context *ctx, | |||
304 | * @param job_headers extra headers to add for this request | 307 | * @param job_headers extra headers to add for this request |
305 | * @param jcc callback to invoke upon completion | 308 | * @param jcc callback to invoke upon completion |
306 | * @param jcc_cls closure for @a jcc | 309 | * @param jcc_cls closure for @a jcc |
307 | * @return NULL on error (in this case, @eh is still released!) | 310 | * @return NULL on error (in this case, @a eh is still released!) |
308 | */ | 311 | */ |
309 | struct GNUNET_CURL_Job * | 312 | struct GNUNET_CURL_Job * |
310 | GNUNET_CURL_job_add2 (struct GNUNET_CURL_Context *ctx, | 313 | GNUNET_CURL_job_add2 (struct GNUNET_CURL_Context *ctx, |
@@ -324,10 +327,9 @@ GNUNET_CURL_job_add2 (struct GNUNET_CURL_Context *ctx, | |||
324 | * @param eh curl easy handle for the request, will | 327 | * @param eh curl easy handle for the request, will |
325 | * be executed AND cleaned up | 328 | * be executed AND cleaned up |
326 | * @param job_headers extra headers to add for this request | 329 | * @param job_headers extra headers to add for this request |
327 | * @param max_reply_size largest acceptable response body | ||
328 | * @param jcc callback to invoke upon completion | 330 | * @param jcc callback to invoke upon completion |
329 | * @param jcc_cls closure for @a jcc | 331 | * @param jcc_cls closure for @a jcc |
330 | * @return NULL on error (in this case, @eh is still released!) | 332 | * @return NULL on error (in this case, @a eh is still released!) |
331 | */ | 333 | */ |
332 | struct GNUNET_CURL_Job * | 334 | struct GNUNET_CURL_Job * |
333 | GNUNET_CURL_job_add_raw (struct GNUNET_CURL_Context *ctx, | 335 | GNUNET_CURL_job_add_raw (struct GNUNET_CURL_Context *ctx, |
@@ -437,4 +439,6 @@ GNUNET_CURL_is_valid_scope_id (const char *scope_id); | |||
437 | #endif | 439 | #endif |
438 | /** @} */ /* end of group */ | 440 | /** @} */ /* end of group */ |
439 | 441 | ||
442 | /** @} */ /* end of group addition to lib_extra */ | ||
443 | |||
440 | /* end of gnunet_curl_lib.h */ | 444 | /* end of gnunet_curl_lib.h */ |
diff --git a/src/include/gnunet_dhtu_plugin.h b/src/include/gnunet_dhtu_plugin.h index fa0b5f667..81b0f1d7b 100644 --- a/src/include/gnunet_dhtu_plugin.h +++ b/src/include/gnunet_dhtu_plugin.h | |||
@@ -119,7 +119,7 @@ struct GNUNET_DHTU_PluginEnvironment | |||
119 | * @param cls the closure | 119 | * @param cls the closure |
120 | * @param target handle to the target, | 120 | * @param target handle to the target, |
121 | * pointer will remain valid until @e disconnect_cb is called | 121 | * pointer will remain valid until @e disconnect_cb is called |
122 | * @para pid peer identity, | 122 | * @param pid peer identity, |
123 | * pointer will remain valid until @e disconnect_cb is called | 123 | * pointer will remain valid until @e disconnect_cb is called |
124 | * @param[out] ctx storage space for DHT to use in association with this target | 124 | * @param[out] ctx storage space for DHT to use in association with this target |
125 | */ | 125 | */ |
diff --git a/src/include/gnunet_disk_lib.h b/src/include/gnunet_disk_lib.h index 71c1f88a5..c76cdc231 100644 --- a/src/include/gnunet_disk_lib.h +++ b/src/include/gnunet_disk_lib.h | |||
@@ -674,7 +674,7 @@ GNUNET_DISK_directory_scan (const char *dir_name, | |||
674 | * Currently, the glob_pattern only supports asterisks in the last | 674 | * Currently, the glob_pattern only supports asterisks in the last |
675 | * path component. | 675 | * path component. |
676 | * | 676 | * |
677 | * @param glob_patterb the glob pattern to search for | 677 | * @param glob_pattern the glob pattern to search for |
678 | * @param callback the method to call for each file | 678 | * @param callback the method to call for each file |
679 | * @param callback_cls closure for @a callback | 679 | * @param callback_cls closure for @a callback |
680 | * @return the number of files found, -1 on error | 680 | * @return the number of files found, -1 on error |
diff --git a/src/include/gnunet_dnsstub_lib.h b/src/include/gnunet_dnsstub_lib.h index 1310ce55a..4cc5e7fd0 100644 --- a/src/include/gnunet_dnsstub_lib.h +++ b/src/include/gnunet_dnsstub_lib.h | |||
@@ -89,7 +89,7 @@ GNUNET_DNSSTUB_add_dns_sa (struct GNUNET_DNSSTUB_Context *ctx, | |||
89 | * Only effective for requests issued after this call. | 89 | * Only effective for requests issued after this call. |
90 | * | 90 | * |
91 | * @param ctx resolver context to modify | 91 | * @param ctx resolver context to modify |
92 | * @param retry_frequ how long to wait between retries | 92 | * @param retry_freq how long to wait between retries |
93 | */ | 93 | */ |
94 | void | 94 | void |
95 | GNUNET_DNSSTUB_set_retry (struct GNUNET_DNSSTUB_Context *ctx, | 95 | GNUNET_DNSSTUB_set_retry (struct GNUNET_DNSSTUB_Context *ctx, |
diff --git a/src/include/gnunet_friends_lib.h b/src/include/gnunet_friends_lib.h index d591ea082..03fa6c72d 100644 --- a/src/include/gnunet_friends_lib.h +++ b/src/include/gnunet_friends_lib.h | |||
@@ -19,6 +19,9 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @addtogroup Backbone | ||
23 | * @{ | ||
24 | * | ||
22 | * @author Christian Grothoff | 25 | * @author Christian Grothoff |
23 | * | 26 | * |
24 | * @file | 27 | * @file |
@@ -116,3 +119,5 @@ GNUNET_FRIENDS_write (struct GNUNET_FRIENDS_Writer *w, | |||
116 | #endif | 119 | #endif |
117 | 120 | ||
118 | /** @} */ /* end of group */ | 121 | /** @} */ /* end of group */ |
122 | |||
123 | /** @} */ /* end of group addition to backbone */ | ||
diff --git a/src/include/gnunet_fs_service.h b/src/include/gnunet_fs_service.h index 6b664169a..8ae826380 100644 --- a/src/include/gnunet_fs_service.h +++ b/src/include/gnunet_fs_service.h | |||
@@ -111,7 +111,7 @@ typedef int | |||
111 | * into HashMaps. The key may change between FS implementations. | 111 | * into HashMaps. The key may change between FS implementations. |
112 | * | 112 | * |
113 | * @param uri uri to convert to a unique key | 113 | * @param uri uri to convert to a unique key |
114 | * @param key wherer to store the unique key | 114 | * @param key where to store the unique key |
115 | * @return #GNUNET_OK on success | 115 | * @return #GNUNET_OK on success |
116 | */ | 116 | */ |
117 | int | 117 | int |
@@ -464,7 +464,7 @@ GNUNET_FS_GETOPT_KEYWORDS (char shortName, | |||
464 | * @param name long name of the option | 464 | * @param name long name of the option |
465 | * @param argumentHelp help text for the option argument | 465 | * @param argumentHelp help text for the option argument |
466 | * @param description long help text for the option | 466 | * @param description long help text for the option |
467 | * @param[out] metadata set to the desired value | 467 | * @param[out] meta metadata set to the desired value |
468 | */ | 468 | */ |
469 | struct GNUNET_GETOPT_CommandLineOption | 469 | struct GNUNET_GETOPT_CommandLineOption |
470 | GNUNET_FS_GETOPT_METADATA (char shortName, | 470 | GNUNET_FS_GETOPT_METADATA (char shortName, |
diff --git a/src/include/gnunet_getopt_lib.h b/src/include/gnunet_getopt_lib.h index c7c1d57a3..87ad591b7 100644 --- a/src/include/gnunet_getopt_lib.h +++ b/src/include/gnunet_getopt_lib.h | |||
@@ -404,7 +404,6 @@ GNUNET_GETOPT_option_timestamp (char shortName, | |||
404 | * | 404 | * |
405 | * @param shortName short name of the option | 405 | * @param shortName short name of the option |
406 | * @param name long name of the option | 406 | * @param name long name of the option |
407 | * @param argumentHelp help text for the option argument | ||
408 | * @param description long help text for the option | 407 | * @param description long help text for the option |
409 | * @param[out] val set to 1 if the option is present | 408 | * @param[out] val set to 1 if the option is present |
410 | */ | 409 | */ |
diff --git a/src/include/gnunet_gns_service.h b/src/include/gnunet_gns_service.h index d367ac076..a32bb77ae 100644 --- a/src/include/gnunet_gns_service.h +++ b/src/include/gnunet_gns_service.h | |||
@@ -238,3 +238,5 @@ GNUNET_GNS_lookup_with_tld_cancel (struct GNUNET_GNS_LookupWithTldRequest *ltr); | |||
238 | #endif | 238 | #endif |
239 | 239 | ||
240 | /** @} */ /* end of group */ | 240 | /** @} */ /* end of group */ |
241 | |||
242 | /** @} */ /* end of group addition */ | ||
diff --git a/src/include/gnunet_gnsrecord_lib.h b/src/include/gnunet_gnsrecord_lib.h index 21fb610f3..357f87587 100644 --- a/src/include/gnunet_gnsrecord_lib.h +++ b/src/include/gnunet_gnsrecord_lib.h | |||
@@ -528,6 +528,7 @@ GNUNET_GNSRECORD_query_from_private_key ( | |||
528 | 528 | ||
529 | /** | 529 | /** |
530 | * Calculate the DHT query for a given @a label in a given @a zone. | 530 | * Calculate the DHT query for a given @a label in a given @a zone. |
531 | * FIXME: We may want to plugin-ize this at some point. | ||
531 | * | 532 | * |
532 | * @param pub public key of the zone | 533 | * @param pub public key of the zone |
533 | * @param label label of the record | 534 | * @param label label of the record |
@@ -752,7 +753,7 @@ GNUNET_GNSRECORD_is_critical (uint32_t type); | |||
752 | * @param rd input records | 753 | * @param rd input records |
753 | * @param rd_count size of the @a rd and @a rd_public arrays | 754 | * @param rd_count size of the @a rd and @a rd_public arrays |
754 | * @param rd_public where to write the converted records | 755 | * @param rd_public where to write the converted records |
755 | * @param rd_public_count number of records written to @a rd_public | 756 | * @param rd_count_public number of records written to @a rd_public |
756 | * @param min_expiry the minimum expiration of this set | 757 | * @param min_expiry the minimum expiration of this set |
757 | * @param filter the record set filter, see GNUNET_GNSRECORD_Filter. | 758 | * @param filter the record set filter, see GNUNET_GNSRECORD_Filter. |
758 | * @param emsg the error message if something went wrong | 759 | * @param emsg the error message if something went wrong |
@@ -768,7 +769,6 @@ GNUNET_GNSRECORD_normalize_record_set (const char *label, | |||
768 | enum GNUNET_GNSRECORD_Filter filter, | 769 | enum GNUNET_GNSRECORD_Filter filter, |
769 | char **emsg); | 770 | char **emsg); |
770 | 771 | ||
771 | |||
772 | /** | 772 | /** |
773 | * Check label for invalid characters. | 773 | * Check label for invalid characters. |
774 | * | 774 | * |
diff --git a/src/include/gnunet_hello_lib.h b/src/include/gnunet_hello_lib.h index b12108a33..86bf35110 100644 --- a/src/include/gnunet_hello_lib.h +++ b/src/include/gnunet_hello_lib.h | |||
@@ -485,8 +485,8 @@ GNUNET_HELLO_parse_uri (const char *uri, | |||
485 | * @param nt network type of @a address | 485 | * @param nt network type of @a address |
486 | * @param mono_time when was @a address valid | 486 | * @param mono_time when was @a address valid |
487 | * @param private_key signing key to use | 487 | * @param private_key signing key to use |
488 | * @param result[out] where to write address record (allocated) | 488 | * @param[out] result where to write address record (allocated) |
489 | * @param result_size[out] set to size of @a result | 489 | * @param[out] result_size set to size of @a result |
490 | */ | 490 | */ |
491 | void | 491 | void |
492 | GNUNET_HELLO_sign_address ( | 492 | GNUNET_HELLO_sign_address ( |
@@ -504,8 +504,8 @@ GNUNET_HELLO_sign_address ( | |||
504 | * @param raw raw signed address | 504 | * @param raw raw signed address |
505 | * @param raw_size size of @a raw | 505 | * @param raw_size size of @a raw |
506 | * @param pid public key to use for signature verification | 506 | * @param pid public key to use for signature verification |
507 | * @param nt[out] set to network type | 507 | * @param[out] nt set to network type |
508 | * @param mono_time[out] when was the address generated | 508 | * @param[out] mono_time when was the address generated |
509 | * @return NULL on error, otherwise the address | 509 | * @return NULL on error, otherwise the address |
510 | */ | 510 | */ |
511 | char * | 511 | char * |
diff --git a/src/include/gnunet_json_lib.h b/src/include/gnunet_json_lib.h index af63c5e42..8809afb71 100644 --- a/src/include/gnunet_json_lib.h +++ b/src/include/gnunet_json_lib.h | |||
@@ -129,7 +129,7 @@ struct GNUNET_JSON_Specification | |||
129 | * @param root the JSON node to start the navigation at. | 129 | * @param root the JSON node to start the navigation at. |
130 | * @param spec parse specification array | 130 | * @param spec parse specification array |
131 | * @param[out] error_json_name which JSON field was problematic | 131 | * @param[out] error_json_name which JSON field was problematic |
132 | * @param[out] which index into @a spec did we encounter an error | 132 | * @param[out] error_line which index into @a spec did we encounter an error |
133 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error | 133 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
134 | */ | 134 | */ |
135 | enum GNUNET_GenericReturnValue | 135 | enum GNUNET_GenericReturnValue |
@@ -338,7 +338,7 @@ GNUNET_JSON_spec_boolean (const char *name, | |||
338 | * Timestamp. | 338 | * Timestamp. |
339 | * | 339 | * |
340 | * @param name name of the JSON field | 340 | * @param name name of the JSON field |
341 | * @param[out] at where to store the absolute time found under @a name | 341 | * @param[out] t at where to store the absolute time found under @a name |
342 | */ | 342 | */ |
343 | struct GNUNET_JSON_Specification | 343 | struct GNUNET_JSON_Specification |
344 | GNUNET_JSON_spec_timestamp (const char *name, | 344 | GNUNET_JSON_spec_timestamp (const char *name, |
diff --git a/src/include/gnunet_load_lib.h b/src/include/gnunet_load_lib.h index ef596807a..397d3aa2d 100644 --- a/src/include/gnunet_load_lib.h +++ b/src/include/gnunet_load_lib.h | |||
@@ -19,6 +19,9 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @addtogroup libgnunetutil | ||
23 | * @{ | ||
24 | * | ||
22 | * @author Christian Grothoff | 25 | * @author Christian Grothoff |
23 | * | 26 | * |
24 | * @file | 27 | * @file |
@@ -124,4 +127,6 @@ GNUNET_LOAD_update (struct GNUNET_LOAD_Value *load, uint64_t data); | |||
124 | 127 | ||
125 | /** @} */ /* end of group */ | 128 | /** @} */ /* end of group */ |
126 | 129 | ||
130 | /** @} */ /* end of group addition to libgnunetutil */ | ||
131 | |||
127 | /* end of gnunet_load_lib.h */ | 132 | /* end of gnunet_load_lib.h */ |
diff --git a/src/include/gnunet_messenger_service.h b/src/include/gnunet_messenger_service.h index f8bbc7398..12f021d35 100644 --- a/src/include/gnunet_messenger_service.h +++ b/src/include/gnunet_messenger_service.h | |||
@@ -613,9 +613,9 @@ typedef int | |||
613 | * @param[in] cfg Configuration to use | 613 | * @param[in] cfg Configuration to use |
614 | * @param[in] name Name to look up an ego or NULL to stay anonymous | 614 | * @param[in] name Name to look up an ego or NULL to stay anonymous |
615 | * @param[in] identity_callback Function called when the EGO of the handle changes | 615 | * @param[in] identity_callback Function called when the EGO of the handle changes |
616 | * @param[in/out] identity_cls Closure for the <i>identity_callback</i> handler | 616 | * @param[in,out] identity_cls Closure for the <i>identity_callback</i> handler |
617 | * @param[in] msg_callback Function called when a new message is sent or received | 617 | * @param[in] msg_callback Function called when a new message is sent or received |
618 | * @param[in/out] msg_cls Closure for the <i>msg_callback</i> handler | 618 | * @param[in,out] msg_cls Closure for the <i>msg_callback</i> handler |
619 | * @return Messenger handle to use, NULL on error | 619 | * @return Messenger handle to use, NULL on error |
620 | */ | 620 | */ |
621 | struct GNUNET_MESSENGER_Handle* | 621 | struct GNUNET_MESSENGER_Handle* |
@@ -634,7 +634,7 @@ GNUNET_MESSENGER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, | |||
634 | * Keep in mind that this will fully delete the old ego key (if any is used) even if any other service wants to use it | 634 | * Keep in mind that this will fully delete the old ego key (if any is used) even if any other service wants to use it |
635 | * as default. | 635 | * as default. |
636 | * | 636 | * |
637 | * @param[in/out] handle Messenger handle to use | 637 | * @param[in,out] handle Messenger handle to use |
638 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure | 638 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure |
639 | */ | 639 | */ |
640 | int | 640 | int |
@@ -643,7 +643,7 @@ GNUNET_MESSENGER_update (struct GNUNET_MESSENGER_Handle *handle); | |||
643 | /** | 643 | /** |
644 | * Disconnect all of the messengers used services and clears up its used memory. | 644 | * Disconnect all of the messengers used services and clears up its used memory. |
645 | * | 645 | * |
646 | * @param[in/out] handle Messenger handle to use | 646 | * @param[in,out] handle Messenger handle to use |
647 | */ | 647 | */ |
648 | void | 648 | void |
649 | GNUNET_MESSENGER_disconnect (struct GNUNET_MESSENGER_Handle *handle); | 649 | GNUNET_MESSENGER_disconnect (struct GNUNET_MESSENGER_Handle *handle); |
@@ -662,7 +662,7 @@ GNUNET_MESSENGER_get_name (const struct GNUNET_MESSENGER_Handle *handle); | |||
662 | * name to its new directory. If anything fails during this process the function returns #GNUNET_NO and the name for | 662 | * name to its new directory. If anything fails during this process the function returns #GNUNET_NO and the name for |
663 | * the messenger won't change as specified. | 663 | * the messenger won't change as specified. |
664 | * | 664 | * |
665 | * @param[in/out] handle Messenger handle to use | 665 | * @param[in,out] handle Messenger handle to use |
666 | * @param[in] name Name for the messenger to change to | 666 | * @param[in] name Name for the messenger to change to |
667 | * @return #GNUNET_YES on success, #GNUNET_NO on failure and #GNUNET_SYSERR if <i>handle</i> is NULL | 667 | * @return #GNUNET_YES on success, #GNUNET_NO on failure and #GNUNET_SYSERR if <i>handle</i> is NULL |
668 | */ | 668 | */ |
@@ -691,7 +691,7 @@ GNUNET_MESSENGER_get_key (const struct GNUNET_MESSENGER_Handle *handle); | |||
691 | * | 691 | * |
692 | * ( All <b>doors</b> form a ring structured network to shorten the latency sending and receiving messages. ) | 692 | * ( All <b>doors</b> form a ring structured network to shorten the latency sending and receiving messages. ) |
693 | * | 693 | * |
694 | * @param[in/out] handle Messenger handle to use | 694 | * @param[in,out] handle Messenger handle to use |
695 | * @param[in] key Hash identifying the port | 695 | * @param[in] key Hash identifying the port |
696 | * @return Room handle, NULL on error | 696 | * @return Room handle, NULL on error |
697 | */ | 697 | */ |
@@ -712,7 +712,7 @@ GNUNET_MESSENGER_open_room (struct GNUNET_MESSENGER_Handle *handle, | |||
712 | * | 712 | * |
713 | * ( All <b>doors</b> form a ring structured network to shorten the latency sending and receiving messages. ) | 713 | * ( All <b>doors</b> form a ring structured network to shorten the latency sending and receiving messages. ) |
714 | * | 714 | * |
715 | * @param[in/out] handle Messenger handle to use | 715 | * @param[in,out] handle Messenger handle to use |
716 | * @param[in] door Peer identity of an open <b>door</b> | 716 | * @param[in] door Peer identity of an open <b>door</b> |
717 | * @param[in] key Hash identifying the port | 717 | * @param[in] key Hash identifying the port |
718 | * @return Room handle, NULL on error | 718 | * @return Room handle, NULL on error |
@@ -729,7 +729,7 @@ GNUNET_MESSENGER_enter_room (struct GNUNET_MESSENGER_Handle *handle, | |||
729 | * ( After a member closes a <b>door</b>, all members entered through that specific <b>door</b> have to use another one | 729 | * ( After a member closes a <b>door</b>, all members entered through that specific <b>door</b> have to use another one |
730 | * or open the room on their own. ) | 730 | * or open the room on their own. ) |
731 | * | 731 | * |
732 | * @param[in/out] room Room handle | 732 | * @param[in,out] room Room handle |
733 | */ | 733 | */ |
734 | void | 734 | void |
735 | GNUNET_MESSENGER_close_room (struct GNUNET_MESSENGER_Room *room); | 735 | GNUNET_MESSENGER_close_room (struct GNUNET_MESSENGER_Room *room); |
@@ -792,7 +792,7 @@ const struct GNUNET_IDENTITY_PublicKey* | |||
792 | GNUNET_MESSENGER_contact_get_key (const struct GNUNET_MESSENGER_Contact *contact); | 792 | GNUNET_MESSENGER_contact_get_key (const struct GNUNET_MESSENGER_Contact *contact); |
793 | 793 | ||
794 | /** | 794 | /** |
795 | * Send a <i>message</i> into a </i>room</i>. If you opened the <i>room</i> all entered members will receive the | 795 | * Send a <i>message</i> into a <i>room</i>. If you opened the <i>room</i> all entered members will receive the |
796 | * <i>message</i>. If you entered the <i>room</i> through a <b>door</b> all so entered <b>doors</b> will receive the | 796 | * <i>message</i>. If you entered the <i>room</i> through a <b>door</b> all so entered <b>doors</b> will receive the |
797 | * <i>message</i> as well. All members receiving the <i>message</i> will also propagate this <i>message</i> recursively | 797 | * <i>message</i> as well. All members receiving the <i>message</i> will also propagate this <i>message</i> recursively |
798 | * as long as the <i>message</i> is unknown to them. | 798 | * as long as the <i>message</i> is unknown to them. |
@@ -805,7 +805,7 @@ GNUNET_MESSENGER_contact_get_key (const struct GNUNET_MESSENGER_Contact *contact | |||
805 | * | 805 | * |
806 | * Sending a message to all members in a given room can be done by providing NULL as contact. | 806 | * Sending a message to all members in a given room can be done by providing NULL as contact. |
807 | * | 807 | * |
808 | * @param[in/out] room Room handle | 808 | * @param[in,out] room Room handle |
809 | * @param[in] message New message to send | 809 | * @param[in] message New message to send |
810 | * @param[in] contact Contact or NULL | 810 | * @param[in] contact Contact or NULL |
811 | */ | 811 | */ |
diff --git a/src/include/gnunet_mq_lib.h b/src/include/gnunet_mq_lib.h index bf2902707..a06fb4eb7 100644 --- a/src/include/gnunet_mq_lib.h +++ b/src/include/gnunet_mq_lib.h | |||
@@ -390,9 +390,9 @@ typedef void | |||
390 | * FIFO of envelopes independent of MQ itself and wants to | 390 | * FIFO of envelopes independent of MQ itself and wants to |
391 | * re-use the pointers internal to @a env. Use with caution. | 391 | * re-use the pointers internal to @a env. Use with caution. |
392 | * | 392 | * |
393 | * @param[in|out] env_head of envelope DLL | 393 | * @param[in,out] env_head of envelope DLL |
394 | * @param[in|out] env_tail tail of envelope DLL | 394 | * @param[in,out] env_tail tail of envelope DLL |
395 | * @param[in|out] env element to insert at the tail | 395 | * @param[in,out] env element to insert at the tail |
396 | */ | 396 | */ |
397 | void | 397 | void |
398 | GNUNET_MQ_dll_insert_head (struct GNUNET_MQ_Envelope **env_head, | 398 | GNUNET_MQ_dll_insert_head (struct GNUNET_MQ_Envelope **env_head, |
@@ -408,9 +408,9 @@ GNUNET_MQ_dll_insert_head (struct GNUNET_MQ_Envelope **env_head, | |||
408 | * FIFO of envelopes independent of MQ itself and wants to | 408 | * FIFO of envelopes independent of MQ itself and wants to |
409 | * re-use the pointers internal to @a env. Use with caution. | 409 | * re-use the pointers internal to @a env. Use with caution. |
410 | * | 410 | * |
411 | * @param[in|out] env_head of envelope DLL | 411 | * @param[in,out] env_head of envelope DLL |
412 | * @param[in|out] env_tail tail of envelope DLL | 412 | * @param[in,out] env_tail tail of envelope DLL |
413 | * @param[in|out] env element to insert at the tail | 413 | * @param[in,out] env element to insert at the tail |
414 | */ | 414 | */ |
415 | void | 415 | void |
416 | GNUNET_MQ_dll_insert_tail (struct GNUNET_MQ_Envelope **env_head, | 416 | GNUNET_MQ_dll_insert_tail (struct GNUNET_MQ_Envelope **env_head, |
@@ -426,9 +426,9 @@ GNUNET_MQ_dll_insert_tail (struct GNUNET_MQ_Envelope **env_head, | |||
426 | * FIFO of envelopes independent of MQ itself and wants to | 426 | * FIFO of envelopes independent of MQ itself and wants to |
427 | * re-use the pointers internal to @a env. Use with caution. | 427 | * re-use the pointers internal to @a env. Use with caution. |
428 | * | 428 | * |
429 | * @param[in|out] env_head of envelope DLL | 429 | * @param[in,out] env_head of envelope DLL |
430 | * @param[in|out] env_tail tail of envelope DLL | 430 | * @param[in,out] env_tail tail of envelope DLL |
431 | * @param[in|out] env element to remove from the DLL | 431 | * @param[in,out] env element to remove from the DLL |
432 | */ | 432 | */ |
433 | void | 433 | void |
434 | GNUNET_MQ_dll_remove (struct GNUNET_MQ_Envelope **env_head, | 434 | GNUNET_MQ_dll_remove (struct GNUNET_MQ_Envelope **env_head, |
@@ -601,6 +601,7 @@ struct GNUNET_MQ_MessageHandler | |||
601 | * "context"), | 601 | * "context"), |
602 | * GNUNET_MQ_handler_end() | 602 | * GNUNET_MQ_handler_end() |
603 | * }; | 603 | * }; |
604 | * </code> | ||
604 | * | 605 | * |
605 | * @param name unique basename for the functions | 606 | * @param name unique basename for the functions |
606 | * @param code message type constant | 607 | * @param code message type constant |
diff --git a/src/include/gnunet_mst_lib.h b/src/include/gnunet_mst_lib.h index 36b1fd8d5..43a8ab838 100644 --- a/src/include/gnunet_mst_lib.h +++ b/src/include/gnunet_mst_lib.h | |||
@@ -168,6 +168,8 @@ GNUNET_MST_destroy (struct GNUNET_MessageStreamTokenizer *mst); | |||
168 | 168 | ||
169 | /** @} */ /* end of group server */ | 169 | /** @} */ /* end of group server */ |
170 | 170 | ||
171 | /** @} */ /* end of group addition */ | 171 | /** @} */ /* end of group addition to networking */ |
172 | |||
173 | /** @} */ /* end of group addition to libgnunetutil*/ | ||
172 | 174 | ||
173 | /* end of gnunet_mst_lib.h */ | 175 | /* end of gnunet_mst_lib.h */ |
diff --git a/src/include/gnunet_my_lib.h b/src/include/gnunet_my_lib.h index 0c95d50d0..96d8cab42 100644 --- a/src/include/gnunet_my_lib.h +++ b/src/include/gnunet_my_lib.h | |||
@@ -18,6 +18,9 @@ | |||
18 | SPDX-License-Identifier: AGPL3.0-or-later | 18 | SPDX-License-Identifier: AGPL3.0-or-later |
19 | */ | 19 | */ |
20 | /** | 20 | /** |
21 | * @addtogroup lib_extra | ||
22 | * @{ | ||
23 | * | ||
21 | * @author Christian Grothoff | 24 | * @author Christian Grothoff |
22 | * @author Christophe Genevey | 25 | * @author Christophe Genevey |
23 | * | 26 | * |
@@ -126,7 +129,7 @@ struct GNUNET_MY_QueryParam | |||
126 | * @a ptr_size bytes.FG | 129 | * @a ptr_size bytes.FG |
127 | * | 130 | * |
128 | * @param ptr pointer to the query parameter to pass | 131 | * @param ptr pointer to the query parameter to pass |
129 | * @oaran ptr_size number of bytes in @a ptr | 132 | * @param ptr_size number of bytes in @a ptr |
130 | */ | 133 | */ |
131 | struct GNUNET_MY_QueryParam | 134 | struct GNUNET_MY_QueryParam |
132 | GNUNET_MY_query_param_fixed_size (const void *ptr, | 135 | GNUNET_MY_query_param_fixed_size (const void *ptr, |
@@ -262,7 +265,7 @@ struct GNUNET_MY_ResultSpec | |||
262 | * MySQL, store in already allocated buffer at @a ptr. | 265 | * MySQL, store in already allocated buffer at @a ptr. |
263 | * | 266 | * |
264 | * @spec ptr where to write the result | 267 | * @spec ptr where to write the result |
265 | * @oaran ptr_size number of bytes available at @a ptr | 268 | * @param ptr_size number of bytes available at @a ptr |
266 | */ | 269 | */ |
267 | struct GNUNET_MY_ResultSpec | 270 | struct GNUNET_MY_ResultSpec |
268 | GNUNET_MY_result_spec_fixed_size (void *ptr, | 271 | GNUNET_MY_result_spec_fixed_size (void *ptr, |
@@ -271,7 +274,7 @@ GNUNET_MY_result_spec_fixed_size (void *ptr, | |||
271 | /** | 274 | /** |
272 | * Generate query parameter for a string | 275 | * Generate query parameter for a string |
273 | * | 276 | * |
274 | *@param ptr pointer to the string query parameter to pass | 277 | * @param ptr pointer to the string query parameter to pass |
275 | */ | 278 | */ |
276 | struct GNUNET_MY_QueryParam | 279 | struct GNUNET_MY_QueryParam |
277 | GNUNET_MY_query_param_string (const char *ptr); | 280 | GNUNET_MY_query_param_string (const char *ptr); |
@@ -339,7 +342,7 @@ GNUNET_MY_query_param_uint16 (const uint16_t *x); | |||
339 | /** | 342 | /** |
340 | * Generate query parameter for an uint32_t in host byte order | 343 | * Generate query parameter for an uint32_t in host byte order |
341 | * | 344 | * |
342 | *@param x pointer to the query parameter to pass | 345 | * @param x pointer to the query parameter to pass |
343 | */ | 346 | */ |
344 | struct GNUNET_MY_QueryParam | 347 | struct GNUNET_MY_QueryParam |
345 | GNUNET_MY_query_param_uint32 (const uint32_t *x); | 348 | GNUNET_MY_query_param_uint32 (const uint32_t *x); |
@@ -347,7 +350,7 @@ GNUNET_MY_query_param_uint32 (const uint32_t *x); | |||
347 | /** | 350 | /** |
348 | * Generate query parameter for an uint64_t in host byte order | 351 | * Generate query parameter for an uint64_t in host byte order |
349 | * | 352 | * |
350 | *@param x pointer to the query parameter to pass | 353 | * @param x pointer to the query parameter to pass |
351 | */ | 354 | */ |
352 | struct GNUNET_MY_QueryParam | 355 | struct GNUNET_MY_QueryParam |
353 | GNUNET_MY_query_param_uint64 (const uint64_t *x); | 356 | GNUNET_MY_query_param_uint64 (const uint64_t *x); |
@@ -367,8 +370,8 @@ GNUNET_MY_query_param_uint64 (const uint64_t *x); | |||
367 | * Variable-size result expected | 370 | * Variable-size result expected |
368 | * | 371 | * |
369 | * @param[out] dst where to store the result, allocated | 372 | * @param[out] dst where to store the result, allocated |
370 | * @param[out] sptr where to store the size of @a dst | 373 | * @param[out] ptr_size where to store the size of @a dst |
371 | * @return array entru for the result specification to use | 374 | * @return array entry for the result specification to use |
372 | */ | 375 | */ |
373 | struct GNUNET_MY_ResultSpec | 376 | struct GNUNET_MY_ResultSpec |
374 | GNUNET_MY_result_spec_variable_size (void **dst, | 377 | GNUNET_MY_result_spec_variable_size (void **dst, |
@@ -498,3 +501,5 @@ GNUNET_MY_cleanup_result (struct GNUNET_MY_ResultSpec *rs); | |||
498 | #endif | 501 | #endif |
499 | 502 | ||
500 | /** @} */ /* end of group */ | 503 | /** @} */ /* end of group */ |
504 | |||
505 | /** @} */ /* end of group addition to lib_extra */ | ||
diff --git a/src/include/gnunet_nat_auto_service.h b/src/include/gnunet_nat_auto_service.h index 78284dc01..db3a8460d 100644 --- a/src/include/gnunet_nat_auto_service.h +++ b/src/include/gnunet_nat_auto_service.h | |||
@@ -26,7 +26,7 @@ | |||
26 | * Service for testing and autoconfiguration of | 26 | * Service for testing and autoconfiguration of |
27 | * NAT traversal functionality | 27 | * NAT traversal functionality |
28 | * | 28 | * |
29 | * @defgroup nat NAT testing library | 29 | * @defgroup nat NAT library |
30 | * | 30 | * |
31 | * @{ | 31 | * @{ |
32 | */ | 32 | */ |
diff --git a/src/include/gnunet_nc_lib.h b/src/include/gnunet_nc_lib.h index 7eef49900..dbd2aa12f 100644 --- a/src/include/gnunet_nc_lib.h +++ b/src/include/gnunet_nc_lib.h | |||
@@ -104,4 +104,6 @@ GNUNET_notification_context_get_size (struct GNUNET_NotificationContext *nc); | |||
104 | 104 | ||
105 | #endif | 105 | #endif |
106 | 106 | ||
107 | /** @} */ /* end of group mq */ | ||
108 | |||
107 | /** @} */ /* end of group addition */ | 109 | /** @} */ /* end of group addition */ |
diff --git a/src/include/gnunet_nt_lib.h b/src/include/gnunet_nt_lib.h index 5c3ec86af..144a3daa3 100644 --- a/src/include/gnunet_nt_lib.h +++ b/src/include/gnunet_nt_lib.h | |||
@@ -18,6 +18,9 @@ | |||
18 | SPDX-License-Identifier: AGPL3.0-or-later | 18 | SPDX-License-Identifier: AGPL3.0-or-later |
19 | */ | 19 | */ |
20 | /** | 20 | /** |
21 | * @addtogroup Backbone | ||
22 | * @{ | ||
23 | * | ||
21 | * @file network type characterization | 24 | * @file network type characterization |
22 | * @author Christian Grothoff | 25 | * @author Christian Grothoff |
23 | * @author Matthias Wachs | 26 | * @author Matthias Wachs |
@@ -122,3 +125,5 @@ GNUNET_NT_scanner_done (struct GNUNET_NT_InterfaceScanner *is); | |||
122 | #endif | 125 | #endif |
123 | 126 | ||
124 | /** @} */ /* end of group */ | 127 | /** @} */ /* end of group */ |
128 | |||
129 | /** @} */ /* end of group addition to backbone */ | ||
diff --git a/src/include/gnunet_peerinfo_service.h b/src/include/gnunet_peerinfo_service.h index 739e7ed24..3be4a6977 100644 --- a/src/include/gnunet_peerinfo_service.h +++ b/src/include/gnunet_peerinfo_service.h | |||
@@ -142,7 +142,6 @@ struct GNUNET_PEERINFO_IteratorContext; | |||
142 | * @param h handle to the peerinfo service | 142 | * @param h handle to the peerinfo service |
143 | * @param include_friend_only include HELLO messages for friends only | 143 | * @param include_friend_only include HELLO messages for friends only |
144 | * @param peer restrict iteration to this peer only (can be NULL) | 144 | * @param peer restrict iteration to this peer only (can be NULL) |
145 | * @param timeout how long to wait until timing out | ||
146 | * @param callback the method to call for each peer | 145 | * @param callback the method to call for each peer |
147 | * @param callback_cls closure for @a callback | 146 | * @param callback_cls closure for @a callback |
148 | * @return iterator context | 147 | * @return iterator context |
diff --git a/src/include/gnunet_peerstore_service.h b/src/include/gnunet_peerstore_service.h index deea3ae96..f9b283a9f 100644 --- a/src/include/gnunet_peerstore_service.h +++ b/src/include/gnunet_peerstore_service.h | |||
@@ -249,6 +249,7 @@ GNUNET_PEERSTORE_store_cancel (struct GNUNET_PEERSTORE_StoreContext *sc); | |||
249 | * @param key entry key string (can be NULL) | 249 | * @param key entry key string (can be NULL) |
250 | * @param callback function called with each matching record, all NULL's on end | 250 | * @param callback function called with each matching record, all NULL's on end |
251 | * @param callback_cls closure for @a callback | 251 | * @param callback_cls closure for @a callback |
252 | * @return Handle to iteration request | ||
252 | */ | 253 | */ |
253 | struct GNUNET_PEERSTORE_IterateContext * | 254 | struct GNUNET_PEERSTORE_IterateContext * |
254 | GNUNET_PEERSTORE_iterate (struct GNUNET_PEERSTORE_Handle *h, | 255 | GNUNET_PEERSTORE_iterate (struct GNUNET_PEERSTORE_Handle *h, |
diff --git a/src/include/gnunet_pq_lib.h b/src/include/gnunet_pq_lib.h index 7396c6861..d52c0e40d 100644 --- a/src/include/gnunet_pq_lib.h +++ b/src/include/gnunet_pq_lib.h | |||
@@ -118,7 +118,7 @@ GNUNET_PQ_query_param_null (void); | |||
118 | * @a ptr_size bytes. | 118 | * @a ptr_size bytes. |
119 | * | 119 | * |
120 | * @param ptr pointer to the query parameter to pass | 120 | * @param ptr pointer to the query parameter to pass |
121 | * @oaran ptr_size number of bytes in @a ptr | 121 | * @param ptr_size number of bytes in @a ptr |
122 | * @return query parameter to use | 122 | * @return query parameter to use |
123 | */ | 123 | */ |
124 | struct GNUNET_PQ_QueryParam | 124 | struct GNUNET_PQ_QueryParam |
@@ -235,7 +235,7 @@ GNUNET_PQ_query_param_absolute_time_nbo ( | |||
235 | */ | 235 | */ |
236 | struct GNUNET_PQ_QueryParam | 236 | struct GNUNET_PQ_QueryParam |
237 | GNUNET_PQ_query_param_timestamp_nbo ( | 237 | GNUNET_PQ_query_param_timestamp_nbo ( |
238 | const struct GNUNET_TIME_TimestampNBO *t); | 238 | const struct GNUNET_TIME_TimestampNBO *x); |
239 | 239 | ||
240 | 240 | ||
241 | /** | 241 | /** |
@@ -861,7 +861,7 @@ GNUNET_PQ_make_try_execute (const char *sql); | |||
861 | /** | 861 | /** |
862 | * Request execution of an array of statements @a es from Postgres. | 862 | * Request execution of an array of statements @a es from Postgres. |
863 | * | 863 | * |
864 | * @param pq database to execute the statements in | 864 | * @param db database to execute the statements in |
865 | * @param es #GNUNET_PQ_PREPARED_STATEMENT_END-terminated array of prepared | 865 | * @param es #GNUNET_PQ_PREPARED_STATEMENT_END-terminated array of prepared |
866 | * statements. | 866 | * statements. |
867 | * @return #GNUNET_OK on success (modulo statements where errors can be ignored) | 867 | * @return #GNUNET_OK on success (modulo statements where errors can be ignored) |
@@ -903,14 +903,14 @@ enum GNUNET_PQ_Options | |||
903 | * configuration. Initialize logging via GNUnet's log routines and disable | 903 | * configuration. Initialize logging via GNUnet's log routines and disable |
904 | * Postgres's logger. Also ensures that the statements in @a load_path and @a | 904 | * Postgres's logger. Also ensures that the statements in @a load_path and @a |
905 | * es are executed whenever we (re)connect to the database, and that the | 905 | * es are executed whenever we (re)connect to the database, and that the |
906 | * prepared statements in @a ps are "ready". If statements in @es fail that | 906 | * prepared statements in @a ps are "ready". If statements in @a es fail that |
907 | * were created with #GNUNET_PQ_make_execute(), then the entire operation | 907 | * were created with #GNUNET_PQ_make_execute(), then the entire operation |
908 | * fails. | 908 | * fails. |
909 | * | 909 | * |
910 | * In @a load_path, a list of "$XXXX.sql" files is expected where $XXXX | 910 | * In @a load_path, a list of "$XXXX.sql" files is expected where $XXXX |
911 | * must be a sequence of contiguous integer values starting at 0000. | 911 | * must be a sequence of contiguous integer values starting at 0000. |
912 | * These files are then loaded in sequence using "psql $config_str" before | 912 | * These files are then loaded in sequence using "psql $config_str" before |
913 | * running statements from @e es. The directory is inspected again on | 913 | * running statements from @a es. The directory is inspected again on |
914 | * reconnect. | 914 | * reconnect. |
915 | * | 915 | * |
916 | * @param config_str configuration to use | 916 | * @param config_str configuration to use |
@@ -947,7 +947,7 @@ GNUNET_PQ_exec_sql (struct GNUNET_PQ_Context *db, | |||
947 | * configuration. Initialize logging via GNUnet's log routines and disable | 947 | * configuration. Initialize logging via GNUnet's log routines and disable |
948 | * Postgres's logger. Also ensures that the statements in @a load_path and @a | 948 | * Postgres's logger. Also ensures that the statements in @a load_path and @a |
949 | * es are executed whenever we (re)connect to the database, and that the | 949 | * es are executed whenever we (re)connect to the database, and that the |
950 | * prepared statements in @a ps are "ready". If statements in @es fail that | 950 | * prepared statements in @a ps are "ready". If statements in @a es fail that |
951 | * were created with #GNUNET_PQ_make_execute(), then the entire operation | 951 | * were created with #GNUNET_PQ_make_execute(), then the entire operation |
952 | * fails. | 952 | * fails. |
953 | * | 953 | * |
diff --git a/src/include/gnunet_reclaim_lib.h b/src/include/gnunet_reclaim_lib.h index 0d5ef59b7..35b58cd0e 100644 --- a/src/include/gnunet_reclaim_lib.h +++ b/src/include/gnunet_reclaim_lib.h | |||
@@ -515,7 +515,7 @@ GNUNET_RECLAIM_attribute_number_to_typename (uint32_t type); | |||
515 | /** | 515 | /** |
516 | * Get required size for serialization buffer | 516 | * Get required size for serialization buffer |
517 | * | 517 | * |
518 | * @param attrs the attribute list to serialize | 518 | * @param credentials the attribute list to serialize |
519 | * @return the required buffer size | 519 | * @return the required buffer size |
520 | */ | 520 | */ |
521 | size_t | 521 | size_t |
@@ -524,9 +524,9 @@ GNUNET_RECLAIM_credential_list_serialize_get_size ( | |||
524 | 524 | ||
525 | 525 | ||
526 | /** | 526 | /** |
527 | * Destroy claim list | 527 | * Destroy credential list |
528 | * | 528 | * |
529 | * @param attrs list to destroy | 529 | * @param credentials list to destroy |
530 | */ | 530 | */ |
531 | void | 531 | void |
532 | GNUNET_RECLAIM_credential_list_destroy ( | 532 | GNUNET_RECLAIM_credential_list_destroy ( |
@@ -551,15 +551,15 @@ GNUNET_RECLAIM_credential_list_add ( | |||
551 | 551 | ||
552 | 552 | ||
553 | /** | 553 | /** |
554 | * Serialize an attribute list | 554 | * Serialize a credential list |
555 | * | 555 | * |
556 | * @param attrs the attribute list to serialize | 556 | * @param credentials the credential list to serialize |
557 | * @param result the serialized attribute | 557 | * @param result the serialized credential |
558 | * @return length of serialized data | 558 | * @return length of serialized data |
559 | */ | 559 | */ |
560 | size_t | 560 | size_t |
561 | GNUNET_RECLAIM_credential_list_serialize ( | 561 | GNUNET_RECLAIM_credential_list_serialize ( |
562 | const struct GNUNET_RECLAIM_CredentialList *attrs, | 562 | const struct GNUNET_RECLAIM_CredentialList *credentials, |
563 | char *result); | 563 | char *result); |
564 | 564 | ||
565 | 565 | ||
diff --git a/src/include/gnunet_reclaim_service.h b/src/include/gnunet_reclaim_service.h index 9f348a1cb..e9e0f144d 100644 --- a/src/include/gnunet_reclaim_service.h +++ b/src/include/gnunet_reclaim_service.h | |||
@@ -200,7 +200,7 @@ GNUNET_RECLAIM_attribute_store ( | |||
200 | * | 200 | * |
201 | * @param h handle to the re:claimID service | 201 | * @param h handle to the re:claimID service |
202 | * @param pkey private key of the identity | 202 | * @param pkey private key of the identity |
203 | * @param attr the credential value | 203 | * @param credential the credential value |
204 | * @param exp_interval the relative expiration interval for the credential | 204 | * @param exp_interval the relative expiration interval for the credential |
205 | * @param cont continuation to call when done | 205 | * @param cont continuation to call when done |
206 | * @param cont_cls closure for @a cont | 206 | * @param cont_cls closure for @a cont |
@@ -235,7 +235,7 @@ GNUNET_RECLAIM_attribute_delete ( | |||
235 | GNUNET_RECLAIM_ContinuationWithStatus cont, void *cont_cls); | 235 | GNUNET_RECLAIM_ContinuationWithStatus cont, void *cont_cls); |
236 | 236 | ||
237 | /** | 237 | /** |
238 | * Delete a credential. Tickets used to share use a presentation of this | 238 | * Delete a credential. Tickets used to share a presentation of this |
239 | * credential are updated accordingly. | 239 | * credential are updated accordingly. |
240 | * | 240 | * |
241 | * @param h handle to the re:claimID service | 241 | * @param h handle to the re:claimID service |
@@ -349,7 +349,7 @@ GNUNET_RECLAIM_get_credentials_start ( | |||
349 | * Calls the record processor specified in #GNUNET_RECLAIM_get_credentials_start | 349 | * Calls the record processor specified in #GNUNET_RECLAIM_get_credentials_start |
350 | * for the next record. | 350 | * for the next record. |
351 | * | 351 | * |
352 | * @param it the iterator | 352 | * @param ait the iterator |
353 | */ | 353 | */ |
354 | void | 354 | void |
355 | GNUNET_RECLAIM_get_credentials_next ( | 355 | GNUNET_RECLAIM_get_credentials_next ( |
@@ -361,7 +361,7 @@ GNUNET_RECLAIM_get_credentials_next ( | |||
361 | * be called on any iteration that has not yet completed prior to calling | 361 | * be called on any iteration that has not yet completed prior to calling |
362 | * #GNUNET_RECLAIM_disconnect. | 362 | * #GNUNET_RECLAIM_disconnect. |
363 | * | 363 | * |
364 | * @param it the iterator | 364 | * @param ait the iterator |
365 | */ | 365 | */ |
366 | void | 366 | void |
367 | GNUNET_RECLAIM_get_credentials_stop ( | 367 | GNUNET_RECLAIM_get_credentials_stop ( |
diff --git a/src/include/gnunet_resolver_service.h b/src/include/gnunet_resolver_service.h index 956e4d67e..80c92dc4e 100644 --- a/src/include/gnunet_resolver_service.h +++ b/src/include/gnunet_resolver_service.h | |||
@@ -19,6 +19,9 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @addtogroup vpn_suite | ||
23 | * @{ | ||
24 | * | ||
22 | * @author Christian Grothoff | 25 | * @author Christian Grothoff |
23 | * | 26 | * |
24 | * @file | 27 | * @file |
@@ -178,4 +181,6 @@ GNUNET_RESOLVER_request_cancel (struct GNUNET_RESOLVER_RequestHandle *rh); | |||
178 | 181 | ||
179 | /** @} */ /* end of group resolver */ | 182 | /** @} */ /* end of group resolver */ |
180 | 183 | ||
184 | /** @} */ /* end of group addition to vpn_suite */ | ||
185 | |||
181 | /* end of gnunet_resolver_service.h */ | 186 | /* end of gnunet_resolver_service.h */ |
diff --git a/src/include/gnunet_scalarproduct_service.h b/src/include/gnunet_scalarproduct_service.h index 1d775f659..7f60bb325 100644 --- a/src/include/gnunet_scalarproduct_service.h +++ b/src/include/gnunet_scalarproduct_service.h | |||
@@ -179,7 +179,7 @@ GNUNET_SCALARPRODUCT_start_computation ( | |||
179 | struct GNUNET_SCALARPRODUCT_ComputationHandle * | 179 | struct GNUNET_SCALARPRODUCT_ComputationHandle * |
180 | GNUNET_SCALARPRODUCT_accept_computation ( | 180 | GNUNET_SCALARPRODUCT_accept_computation ( |
181 | const struct GNUNET_CONFIGURATION_Handle *cfg, | 181 | const struct GNUNET_CONFIGURATION_Handle *cfg, |
182 | const struct GNUNET_HashCode *key, | 182 | const struct GNUNET_HashCode *session_key, |
183 | const struct GNUNET_SCALARPRODUCT_Element *elements, | 183 | const struct GNUNET_SCALARPRODUCT_Element *elements, |
184 | uint32_t element_count, | 184 | uint32_t element_count, |
185 | GNUNET_SCALARPRODUCT_ContinuationWithStatus cont, | 185 | GNUNET_SCALARPRODUCT_ContinuationWithStatus cont, |
diff --git a/src/include/gnunet_service_lib.h b/src/include/gnunet_service_lib.h index 5baa9100e..8c8591af0 100644 --- a/src/include/gnunet_service_lib.h +++ b/src/include/gnunet_service_lib.h | |||
@@ -282,8 +282,8 @@ GNUNET_SERVICE_run_ (int argc, | |||
282 | * #GNUNET_SERVICE_client_drop(). | 282 | * #GNUNET_SERVICE_client_drop(). |
283 | * | 283 | * |
284 | * @param service_name name of the service to run | 284 | * @param service_name name of the service to run |
285 | * @param options options controlling shutdown of the service | 285 | * @param service_options options controlling shutdown of the service |
286 | * @param service_init_cb function to call once the service is ready | 286 | * @param init_cb function to call once the service is ready |
287 | * @param connect_cb function to call whenever a client connects | 287 | * @param connect_cb function to call whenever a client connects |
288 | * @param disconnect_cb function to call whenever a client disconnects | 288 | * @param disconnect_cb function to call whenever a client disconnects |
289 | * @param cls closure argument for @a service_init_cb, @a connect_cb and @a disconnect_cb | 289 | * @param cls closure argument for @a service_init_cb, @a connect_cb and @a disconnect_cb |
@@ -449,6 +449,8 @@ GNUNET_SERVICE_client_persist (struct GNUNET_SERVICE_Client *c); | |||
449 | 449 | ||
450 | /** @} */ /* end of group service */ | 450 | /** @} */ /* end of group service */ |
451 | 451 | ||
452 | /** @} */ /* end of group addition */ | 452 | /** @} */ /* end of group addition to networking*/ |
453 | |||
454 | /** @} */ /* end of group addition to libgnunetutil */ | ||
453 | 455 | ||
454 | /* end of gnunet_service_lib.h */ | 456 | /* end of gnunet_service_lib.h */ |
diff --git a/src/include/gnunet_set_service.h b/src/include/gnunet_set_service.h index 25e3e9630..255eef265 100644 --- a/src/include/gnunet_set_service.h +++ b/src/include/gnunet_set_service.h | |||
@@ -368,10 +368,10 @@ GNUNET_SET_add_element (struct GNUNET_SET_Handle *set, | |||
368 | 368 | ||
369 | 369 | ||
370 | /** | 370 | /** |
371 | * Remove an element to the given set. | 371 | * Remove an element to the given set. |
372 | * After the element has been removed (in the sense of the | 372 | * After the element has been removed (in the sense of the request |
373 | * request being transmitted to the set service), cont will be called. | 373 | * being transmitted to the set service), @a cont will be called. |
374 | * Calls to remove_element can be queued | 374 | * Multiple calls to GNUNET_SET_remove_element() can be queued |
375 | * | 375 | * |
376 | * @param set set to remove element from | 376 | * @param set set to remove element from |
377 | * @param element element to remove from the set | 377 | * @param element element to remove from the set |
@@ -559,7 +559,7 @@ GNUNET_SET_element_dup (const struct GNUNET_SET_Element *element); | |||
559 | * Hash a set element. | 559 | * Hash a set element. |
560 | * | 560 | * |
561 | * @param element the element that should be hashed | 561 | * @param element the element that should be hashed |
562 | * @param ret_hash a pointer to where the hash of @a element | 562 | * @param[out] ret_hash a pointer to where the hash of @a element |
563 | * should be stored | 563 | * should be stored |
564 | */ | 564 | */ |
565 | void | 565 | void |
diff --git a/src/include/gnunet_setu_service.h b/src/include/gnunet_setu_service.h index fb2614bc8..89ac3cd07 100644 --- a/src/include/gnunet_setu_service.h +++ b/src/include/gnunet_setu_service.h | |||
@@ -291,9 +291,9 @@ GNUNET_SETU_destroy (struct GNUNET_SETU_Handle *set); | |||
291 | 291 | ||
292 | 292 | ||
293 | /** | 293 | /** |
294 | * Prepare a set operation to be evaluated with another peer. The evaluation | 294 | * Prepare a set operation to be evaluated with another peer. |
295 | * will not start until the client provides a local set with | 295 | * The evaluation will not start until the client provides a |
296 | * GNUNET_SETU_commit(). | 296 | * local set with GNUNET_SETU_commit(). |
297 | * | 297 | * |
298 | * @param other_peer peer with the other set | 298 | * @param other_peer peer with the other set |
299 | * @param app_id hash for the application using the set | 299 | * @param app_id hash for the application using the set |
diff --git a/src/include/gnunet_socks.h b/src/include/gnunet_socks.h index 1a6ae1119..b82943da3 100644 --- a/src/include/gnunet_socks.h +++ b/src/include/gnunet_socks.h | |||
@@ -19,6 +19,9 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @addtogroup libgnunetutil | ||
23 | * @{ | ||
24 | * | ||
22 | * @author Jeffrey Burdges | 25 | * @author Jeffrey Burdges |
23 | * | 26 | * |
24 | * @file | 27 | * @file |
@@ -81,4 +84,6 @@ GNUNET_SOCKS_do_connect (const char *service_name, | |||
81 | 84 | ||
82 | /** @} */ /* end of group */ | 85 | /** @} */ /* end of group */ |
83 | 86 | ||
87 | /** @} */ /* end of group addition to libgnunetutil */ | ||
88 | |||
84 | /* end of gnunet_socks.h */ | 89 | /* end of gnunet_socks.h */ |
diff --git a/src/include/gnunet_sq_lib.h b/src/include/gnunet_sq_lib.h index 51713e755..3406b9031 100644 --- a/src/include/gnunet_sq_lib.h +++ b/src/include/gnunet_sq_lib.h | |||
@@ -91,7 +91,7 @@ struct GNUNET_SQ_QueryParam | |||
91 | * @a ptr_size bytes. | 91 | * @a ptr_size bytes. |
92 | * | 92 | * |
93 | * @param ptr pointer to the query parameter to pass | 93 | * @param ptr pointer to the query parameter to pass |
94 | * @oaran ptr_size number of bytes in @a ptr | 94 | * @param ptr_size number of bytes in @a ptr |
95 | */ | 95 | */ |
96 | struct GNUNET_SQ_QueryParam | 96 | struct GNUNET_SQ_QueryParam |
97 | GNUNET_SQ_query_param_fixed_size (const void *ptr, | 97 | GNUNET_SQ_query_param_fixed_size (const void *ptr, |
diff --git a/src/include/gnunet_strings_lib.h b/src/include/gnunet_strings_lib.h index e96888db5..7e06768b8 100644 --- a/src/include/gnunet_strings_lib.h +++ b/src/include/gnunet_strings_lib.h | |||
@@ -403,7 +403,7 @@ GNUNET_STRINGS_base64_encode (const void *in, | |||
403 | * | 403 | * |
404 | * @param data the data to decode | 404 | * @param data the data to decode |
405 | * @param len the length of the input | 405 | * @param len the length of the input |
406 | * @param output where to write the output (*output should be NULL, | 406 | * @param out where to write the output (*out should be NULL, |
407 | * is allocated) | 407 | * is allocated) |
408 | * @return the size of the output | 408 | * @return the size of the output |
409 | */ | 409 | */ |
@@ -448,7 +448,7 @@ GNUNET_STRINGS_base64_decode (const char *data, | |||
448 | * | 448 | * |
449 | * @param data the data to decode | 449 | * @param data the data to decode |
450 | * @param len the length of the input | 450 | * @param len the length of the input |
451 | * @param output where to write the output (*output should be NULL, | 451 | * @param out where to write the output (*out should be NULL, |
452 | * is allocated) | 452 | * is allocated) |
453 | * @return the size of the output | 453 | * @return the size of the output |
454 | */ | 454 | */ |
diff --git a/src/include/gnunet_testbed_service.h b/src/include/gnunet_testbed_service.h index 29515b7af..ef67ab8ca 100644 --- a/src/include/gnunet_testbed_service.h +++ b/src/include/gnunet_testbed_service.h | |||
@@ -1030,8 +1030,8 @@ enum GNUNET_TESTBED_TopologyOption | |||
1030 | * Configure overall network topology to have a particular shape. | 1030 | * Configure overall network topology to have a particular shape. |
1031 | * | 1031 | * |
1032 | * @param op_cls closure argument to give with the operation event | 1032 | * @param op_cls closure argument to give with the operation event |
1033 | * @param num_peers number of peers in 'peers' | 1033 | * @param num_peers number of peers in @a peers |
1034 | * @param peers array of 'num_peers' with the peers to configure | 1034 | * @param peers array of @a num_peers with the peers to configure |
1035 | * @param topo desired underlay topology to use | 1035 | * @param topo desired underlay topology to use |
1036 | * @param ap topology-specific options | 1036 | * @param ap topology-specific options |
1037 | * @return handle to the operation, NULL if configuring the topology | 1037 | * @return handle to the operation, NULL if configuring the topology |
@@ -1052,8 +1052,8 @@ GNUNET_TESTBED_underlay_configure_topology_va (void *op_cls, | |||
1052 | * Configure overall network topology to have a particular shape. | 1052 | * Configure overall network topology to have a particular shape. |
1053 | * | 1053 | * |
1054 | * @param op_cls closure argument to give with the operation event | 1054 | * @param op_cls closure argument to give with the operation event |
1055 | * @param num_peers number of peers in 'peers' | 1055 | * @param num_peers number of peers in @a peers |
1056 | * @param peers array of 'num_peers' with the peers to configure | 1056 | * @param peers array of @a num_peers with the peers to configure |
1057 | * @param topo desired underlay topology to use | 1057 | * @param topo desired underlay topology to use |
1058 | * @param ... topology-specific options | 1058 | * @param ... topology-specific options |
1059 | * @return handle to the operation, NULL if configuring the topology | 1059 | * @return handle to the operation, NULL if configuring the topology |
diff --git a/src/include/gnunet_testing_lib.h b/src/include/gnunet_testing_lib.h index 724382c66..2f64c306b 100644 --- a/src/include/gnunet_testing_lib.h +++ b/src/include/gnunet_testing_lib.h | |||
@@ -401,7 +401,7 @@ typedef void | |||
401 | * Starts a peer using the given configuration and then invokes the | 401 | * Starts a peer using the given configuration and then invokes the |
402 | * given callback. This function ALSO initializes the scheduler loop | 402 | * given callback. This function ALSO initializes the scheduler loop |
403 | * and should thus be called directly from "main". The testcase | 403 | * and should thus be called directly from "main". The testcase |
404 | * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'. | 404 | * should self-terminate by invoking #GNUNET_SCHEDULER_shutdown(). |
405 | * | 405 | * |
406 | * @param testdir only the directory name without any path. This is used for | 406 | * @param testdir only the directory name without any path. This is used for |
407 | * all service homes; the directory will be created in a temporary | 407 | * all service homes; the directory will be created in a temporary |
@@ -409,7 +409,7 @@ typedef void | |||
409 | * @param cfgfilename name of the configuration file to use; | 409 | * @param cfgfilename name of the configuration file to use; |
410 | * use NULL to only run with defaults | 410 | * use NULL to only run with defaults |
411 | * @param tm main function of the testcase | 411 | * @param tm main function of the testcase |
412 | * @param tm_cls closure for 'tm' | 412 | * @param tm_cls closure for @a tm |
413 | * @return 0 on success, 1 on error | 413 | * @return 0 on success, 1 on error |
414 | */ | 414 | */ |
415 | int | 415 | int |
@@ -425,7 +425,7 @@ GNUNET_TESTING_peer_run (const char *testdir, | |||
425 | * Starts a service using the given configuration and then invokes the | 425 | * Starts a service using the given configuration and then invokes the |
426 | * given callback. This function ALSO initializes the scheduler loop | 426 | * given callback. This function ALSO initializes the scheduler loop |
427 | * and should thus be called directly from "main". The testcase | 427 | * and should thus be called directly from "main". The testcase |
428 | * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'. | 428 | * should self-terminate by invoking #GNUNET_SCHEDULER_shutdown(). |
429 | * | 429 | * |
430 | * This function is useful if the testcase is for a single service | 430 | * This function is useful if the testcase is for a single service |
431 | * and if that service doesn't itself depend on other services. | 431 | * and if that service doesn't itself depend on other services. |
diff --git a/src/include/gnunet_testing_netjail_lib.h b/src/include/gnunet_testing_netjail_lib.h index ea44e030d..f736e1b42 100644 --- a/src/include/gnunet_testing_netjail_lib.h +++ b/src/include/gnunet_testing_netjail_lib.h | |||
@@ -470,12 +470,11 @@ GNUNET_TESTING_cmd_stop_testing_system ( | |||
470 | const char *helper_start_label, | 470 | const char *helper_start_label, |
471 | struct GNUNET_TESTING_NetjailTopology *topology); | 471 | struct GNUNET_TESTING_NetjailTopology *topology); |
472 | 472 | ||
473 | |||
474 | /** | 473 | /** |
475 | * Create a GNUNET_CMDS_LOCAL_FINISHED message. | 474 | * Create a GNUNET_CMDS_LOCAL_FINISHED message. |
476 | * | 475 | * |
477 | * @return The GNUNET_CMDS_LOCAL_FINISHED message. | 476 | * @return The GNUNET_CMDS_LOCAL_FINISHED message. |
478 | */ | 477 | */ |
479 | struct GNUNET_MessageHeader * | 478 | struct GNUNET_MessageHeader * |
480 | GNUNET_TESTING_send_local_test_finished_msg (); | 479 | GNUNET_TESTING_send_local_test_finished_msg (); |
481 | 480 | ||
@@ -546,7 +545,6 @@ GNUNET_TESTING_cmd_local_test_finished ( | |||
546 | * | 545 | * |
547 | * @param label name for command. | 546 | * @param label name for command. |
548 | * @param write_message Callback to write messages to the master loop. | 547 | * @param write_message Callback to write messages to the master loop. |
549 | * @param all_local_tests_prepared Flag which will be set from outside. | ||
550 | * @return command. | 548 | * @return command. |
551 | */ | 549 | */ |
552 | struct GNUNET_TESTING_Command | 550 | struct GNUNET_TESTING_Command |
diff --git a/src/include/gnunet_testing_ng_lib.h b/src/include/gnunet_testing_ng_lib.h index 1bc66e59d..d810a5342 100644 --- a/src/include/gnunet_testing_ng_lib.h +++ b/src/include/gnunet_testing_ng_lib.h | |||
@@ -415,7 +415,7 @@ GNUNET_TESTING_interpreter_get_current_command ( | |||
415 | /** | 415 | /** |
416 | * Check if the command is running. | 416 | * Check if the command is running. |
417 | * | 417 | * |
418 | * @param cmd The command to check. | 418 | * @param command The command to check. |
419 | * @return GNUNET_NO if the command is not running, GNUNET_YES if it is running. | 419 | * @return GNUNET_NO if the command is not running, GNUNET_YES if it is running. |
420 | */ | 420 | */ |
421 | enum GNUNET_GenericReturnValue | 421 | enum GNUNET_GenericReturnValue |
@@ -425,7 +425,7 @@ GNUNET_TESTING_running (const struct GNUNET_TESTING_Command *command); | |||
425 | /** | 425 | /** |
426 | * Check if a command is finished. | 426 | * Check if a command is finished. |
427 | * | 427 | * |
428 | * @param cmd The command to check. | 428 | * @param command The command to check. |
429 | * @return GNUNET_NO if the command is not finished, GNUNET_YES if it is finished. | 429 | * @return GNUNET_NO if the command is not finished, GNUNET_YES if it is finished. |
430 | */ | 430 | */ |
431 | enum GNUNET_GenericReturnValue | 431 | enum GNUNET_GenericReturnValue |
diff --git a/src/include/gnunet_time_lib.h b/src/include/gnunet_time_lib.h index d753d62f7..e66ce6ea9 100644 --- a/src/include/gnunet_time_lib.h +++ b/src/include/gnunet_time_lib.h | |||
@@ -242,7 +242,7 @@ GNUNET_TIME_timestamp2s (struct GNUNET_TIME_Timestamp ts); | |||
242 | * Note that the returned value will be overwritten if this function | 242 | * Note that the returned value will be overwritten if this function |
243 | * is called again. | 243 | * is called again. |
244 | * | 244 | * |
245 | * @param t the absolute time to convert | 245 | * @param ts the absolute time to convert |
246 | * @return timestamp in human-readable form in local time | 246 | * @return timestamp in human-readable form in local time |
247 | */ | 247 | */ |
248 | const char * | 248 | const char * |
diff --git a/src/include/gnunet_transport_application_service.h b/src/include/gnunet_transport_application_service.h index 5767082d9..9a6ddd36a 100644 --- a/src/include/gnunet_transport_application_service.h +++ b/src/include/gnunet_transport_application_service.h | |||
@@ -27,9 +27,7 @@ | |||
27 | * @author Christian Grothoff | 27 | * @author Christian Grothoff |
28 | * @author Matthias Wachs | 28 | * @author Matthias Wachs |
29 | * | 29 | * |
30 | * @defgroup TRANSPORT service | 30 | * @defgroup transport Transport service |
31 | * Bandwidth allocation | ||
32 | * | ||
33 | * @{ | 31 | * @{ |
34 | */ | 32 | */ |
35 | #ifndef GNUNET_TRANSPORT_APPLICATION_SERVICE_H | 33 | #ifndef GNUNET_TRANSPORT_APPLICATION_SERVICE_H |
diff --git a/src/include/gnunet_transport_communication_service.h b/src/include/gnunet_transport_communication_service.h index 9b536297e..6c99de78e 100644 --- a/src/include/gnunet_transport_communication_service.h +++ b/src/include/gnunet_transport_communication_service.h | |||
@@ -138,7 +138,8 @@ typedef void (*GNUNET_TRANSPORT_CommunicatorNotify) ( | |||
138 | * Connect to the transport service. | 138 | * Connect to the transport service. |
139 | * | 139 | * |
140 | * @param cfg configuration to use | 140 | * @param cfg configuration to use |
141 | * @param config_section section of the configuration to use for options | 141 | * @param config_section_name section of the configuration to use for |
142 | * options | ||
142 | * @param addr_prefix address prefix for addresses supported by this | 143 | * @param addr_prefix address prefix for addresses supported by this |
143 | * communicator, could be NULL for incoming-only communicators | 144 | * communicator, could be NULL for incoming-only communicators |
144 | * @param cc what characteristics does the communicator have? | 145 | * @param cc what characteristics does the communicator have? |
@@ -283,7 +284,7 @@ GNUNET_TRANSPORT_communicator_mq_add ( | |||
283 | * Notify transport service that an MQ was updated | 284 | * Notify transport service that an MQ was updated |
284 | * | 285 | * |
285 | * @param ch connection to transport service | 286 | * @param ch connection to transport service |
286 | * @param qh the queue to update | 287 | * @param u_qh the queue to update |
287 | * @param q_len number of messages that can be send through this queue | 288 | * @param q_len number of messages that can be send through this queue |
288 | * @param priority queue priority. Queues with highest priority should be | 289 | * @param priority queue priority. Queues with highest priority should be |
289 | * used | 290 | * used |
diff --git a/src/include/gnunet_transport_service.h b/src/include/gnunet_transport_service.h index 99246f136..daa79bf1c 100644 --- a/src/include/gnunet_transport_service.h +++ b/src/include/gnunet_transport_service.h | |||
@@ -360,8 +360,9 @@ typedef void | |||
360 | * @param cfg configuration to use | 360 | * @param cfg configuration to use |
361 | * @param peer a specific peer identity to obtain information for, | 361 | * @param peer a specific peer identity to obtain information for, |
362 | * NULL for all peers | 362 | * NULL for all peers |
363 | * @param one_shot #GNUNET_YES to return the current state and then end (with | 363 | * @param one_shot #GNUNET_YES to return the current state and |
364 | * NULL+NULL), #GNUNET_NO to monitor peers continuously | 364 | * then end (with NULL+NULL), |
365 | * #GNUNET_NO to monitor peers continuously | ||
365 | * @param peer_callback function to call with the results | 366 | * @param peer_callback function to call with the results |
366 | * @param peer_callback_cls closure for @a peer_callback | 367 | * @param peer_callback_cls closure for @a peer_callback |
367 | */ | 368 | */ |