diff options
author | Alessio Vanni <vannilla@firemail.cc> | 2021-04-24 17:30:45 +0200 |
---|---|---|
committer | Alessio Vanni <vannilla@firemail.cc> | 2021-04-24 17:30:45 +0200 |
commit | b996ba4156678b6a0a551b9a932867b2ade42344 (patch) | |
tree | b03c302dddcccae0c0a3f76898617b83b1157528 /src | |
parent | 8233e282046e27de57de75f175e131a974087618 (diff) | |
download | gnunet-b996ba4156678b6a0a551b9a932867b2ade42344.tar.gz gnunet-b996ba4156678b6a0a551b9a932867b2ade42344.zip |
-Fix several incorrect uses of `i.e.'
With some other changes to sentences here and there as I found appropriate.
Diffstat (limited to 'src')
71 files changed, 158 insertions, 166 deletions
diff --git a/src/abd/plugin_gnsrecord_abd.c b/src/abd/plugin_gnsrecord_abd.c index 272872e24..25dc20152 100644 --- a/src/abd/plugin_gnsrecord_abd.c +++ b/src/abd/plugin_gnsrecord_abd.c | |||
@@ -276,7 +276,7 @@ static struct | |||
276 | 276 | ||
277 | 277 | ||
278 | /** | 278 | /** |
279 | * Convert a type name (i.e. "AAAA") to the corresponding number. | 279 | * Convert a type name (e.g. "AAAA") to the corresponding number. |
280 | * | 280 | * |
281 | * @param cls closure, unused | 281 | * @param cls closure, unused |
282 | * @param gns_typename name to convert | 282 | * @param gns_typename name to convert |
@@ -296,7 +296,7 @@ abd_typename_to_number (void *cls, const char *gns_typename) | |||
296 | 296 | ||
297 | 297 | ||
298 | /** | 298 | /** |
299 | * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") | 299 | * Convert a type number to the corresponding type string (e.g. 1 to "A") |
300 | * | 300 | * |
301 | * @param cls closure, unused | 301 | * @param cls closure, unused |
302 | * @param type number of a type to convert | 302 | * @param type number of a type to convert |
diff --git a/src/conversation/plugin_gnsrecord_conversation.c b/src/conversation/plugin_gnsrecord_conversation.c index 2ea2f48f0..786711c8e 100644 --- a/src/conversation/plugin_gnsrecord_conversation.c +++ b/src/conversation/plugin_gnsrecord_conversation.c | |||
@@ -179,7 +179,7 @@ static struct | |||
179 | 179 | ||
180 | 180 | ||
181 | /** | 181 | /** |
182 | * Convert a type name (i.e. "AAAA") to the corresponding number. | 182 | * Convert a type name (e.g. "AAAA") to the corresponding number. |
183 | * | 183 | * |
184 | * @param cls closure, unused | 184 | * @param cls closure, unused |
185 | * @param gns_typename name to convert | 185 | * @param gns_typename name to convert |
@@ -201,7 +201,7 @@ conversation_typename_to_number (void *cls, | |||
201 | 201 | ||
202 | 202 | ||
203 | /** | 203 | /** |
204 | * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") | 204 | * Convert a type number to the corresponding type string (e.g. 1 to "A") |
205 | * | 205 | * |
206 | * @param cls closure, unused | 206 | * @param cls closure, unused |
207 | * @param type number of a type to convert | 207 | * @param type number of a type to convert |
diff --git a/src/curl/curl.c b/src/curl/curl.c index deb14a926..949b9a1b0 100644 --- a/src/curl/curl.c +++ b/src/curl/curl.c | |||
@@ -697,7 +697,7 @@ GNUNET_CURL_job_cancel (struct GNUNET_CURL_Job *job) | |||
697 | /** | 697 | /** |
698 | * Test if the given content type @a ct is JSON | 698 | * Test if the given content type @a ct is JSON |
699 | * | 699 | * |
700 | * @param ct a content type, i.e. "application/json; charset=UTF-8" | 700 | * @param ct a content type, e.g. "application/json; charset=UTF-8" |
701 | * @return true if @a ct denotes JSON | 701 | * @return true if @a ct denotes JSON |
702 | */ | 702 | */ |
703 | static bool | 703 | static bool |
@@ -741,7 +741,7 @@ is_json (const char *ct) | |||
741 | * @param db download buffer | 741 | * @param db download buffer |
742 | * @param eh CURL handle (to get the response code) | 742 | * @param eh CURL handle (to get the response code) |
743 | * @param[out] response_code set to the HTTP response code | 743 | * @param[out] response_code set to the HTTP response code |
744 | * (or zero if we aborted the download, i.e. | 744 | * (or zero if we aborted the download, for example |
745 | * because the response was too big, or if | 745 | * because the response was too big, or if |
746 | * the JSON we received was malformed). | 746 | * the JSON we received was malformed). |
747 | * @return NULL if downloading a JSON reply failed. | 747 | * @return NULL if downloading a JSON reply failed. |
diff --git a/src/datacache/datacache.c b/src/datacache/datacache.c index 5fc5a7481..331a9b784 100644 --- a/src/datacache/datacache.c +++ b/src/datacache/datacache.c | |||
@@ -66,12 +66,12 @@ struct GNUNET_DATACACHE_Handle | |||
66 | struct GNUNET_DATACACHE_PluginFunctions *api; | 66 | struct GNUNET_DATACACHE_PluginFunctions *api; |
67 | 67 | ||
68 | /** | 68 | /** |
69 | * Short name for the plugin (i.e. "sqlite"). | 69 | * Short name for the plugin (e.g. "sqlite"). |
70 | */ | 70 | */ |
71 | char *short_name; | 71 | char *short_name; |
72 | 72 | ||
73 | /** | 73 | /** |
74 | * Name of the library (i.e. "gnunet_plugin_datacache_sqlite"). | 74 | * Name of the library (e.g. "gnunet_plugin_datacache_sqlite"). |
75 | */ | 75 | */ |
76 | char *lib_name; | 76 | char *lib_name; |
77 | 77 | ||
diff --git a/src/datastore/gnunet-service-datastore.c b/src/datastore/gnunet-service-datastore.c index 1c9e5e463..97888ce03 100644 --- a/src/datastore/gnunet-service-datastore.c +++ b/src/datastore/gnunet-service-datastore.c | |||
@@ -84,12 +84,12 @@ struct DatastorePlugin | |||
84 | struct GNUNET_DATASTORE_PluginFunctions *api; | 84 | struct GNUNET_DATASTORE_PluginFunctions *api; |
85 | 85 | ||
86 | /** | 86 | /** |
87 | * Short name for the plugin (i.e. "sqlite"). | 87 | * Short name for the plugin (e.g. "sqlite"). |
88 | */ | 88 | */ |
89 | char *short_name; | 89 | char *short_name; |
90 | 90 | ||
91 | /** | 91 | /** |
92 | * Name of the library (i.e. "gnunet_plugin_datastore_sqlite"). | 92 | * Name of the library (e.g. "gnunet_plugin_datastore_sqlite"). |
93 | */ | 93 | */ |
94 | char *lib_name; | 94 | char *lib_name; |
95 | 95 | ||
diff --git a/src/dht/dht_api.c b/src/dht/dht_api.c index ffcfba997..96399cb5a 100644 --- a/src/dht/dht_api.c +++ b/src/dht/dht_api.c | |||
@@ -1026,7 +1026,7 @@ GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle, | |||
1026 | * has not yet been sent to the service, cancelling the PUT will stop | 1026 | * has not yet been sent to the service, cancelling the PUT will stop |
1027 | * this from happening (but there is no way for the user of this API | 1027 | * this from happening (but there is no way for the user of this API |
1028 | * to tell if that is the case). The only use for this API is to | 1028 | * to tell if that is the case). The only use for this API is to |
1029 | * prevent a later call to 'cont' from #GNUNET_DHT_put (i.e. because | 1029 | * prevent a later call to 'cont' from #GNUNET_DHT_put (e.g. because |
1030 | * the system is shutting down). | 1030 | * the system is shutting down). |
1031 | * | 1031 | * |
1032 | * @param ph put operation to cancel ('cont' will no longer be called) | 1032 | * @param ph put operation to cancel ('cont' will no longer be called) |
diff --git a/src/dht/gnunet-service-dht_clients.c b/src/dht/gnunet-service-dht_clients.c index dfa8ee380..cfcb25336 100644 --- a/src/dht/gnunet-service-dht_clients.c +++ b/src/dht/gnunet-service-dht_clients.c | |||
@@ -1482,7 +1482,7 @@ GDS_CLIENTS_stop () | |||
1482 | /** | 1482 | /** |
1483 | * Define "main" method using service macro. | 1483 | * Define "main" method using service macro. |
1484 | * | 1484 | * |
1485 | * @param name name of the service, i.e. "dht" or "xdht" | 1485 | * @param name name of the service, like "dht" or "xdht" |
1486 | * @param run name of the initializaton method for the service | 1486 | * @param run name of the initializaton method for the service |
1487 | */ | 1487 | */ |
1488 | #define GDS_DHT_SERVICE_INIT(name, run) \ | 1488 | #define GDS_DHT_SERVICE_INIT(name, run) \ |
diff --git a/src/fragmentation/test_fragmentation.c b/src/fragmentation/test_fragmentation.c index 4c71e0195..77879f75b 100644 --- a/src/fragmentation/test_fragmentation.c +++ b/src/fragmentation/test_fragmentation.c | |||
@@ -108,7 +108,7 @@ proc_msgs (void *cls, const struct GNUNET_MessageHeader *hdr) | |||
108 | if (0 == (total % (NUM_MSGS / 100))) | 108 | if (0 == (total % (NUM_MSGS / 100))) |
109 | fprintf (stderr, "%s", "."); | 109 | fprintf (stderr, "%s", "."); |
110 | #endif | 110 | #endif |
111 | /* tolerate 10% loss, i.e. due to duplicate fragment IDs */ | 111 | /* tolerate 10% loss, e.g. due to duplicate fragment IDs */ |
112 | if ((total >= NUM_MSGS - (NUM_MSGS / 10)) && (ret != 0)) | 112 | if ((total >= NUM_MSGS - (NUM_MSGS / 10)) && (ret != 0)) |
113 | { | 113 | { |
114 | if (NULL == shutdown_task) | 114 | if (NULL == shutdown_task) |
diff --git a/src/fragmentation/test_fragmentation_parallel.c b/src/fragmentation/test_fragmentation_parallel.c index 000ca60d2..d19296cf5 100644 --- a/src/fragmentation/test_fragmentation_parallel.c +++ b/src/fragmentation/test_fragmentation_parallel.c | |||
@@ -100,7 +100,7 @@ proc_msgs (void *cls, const struct GNUNET_MessageHeader *hdr) | |||
100 | if (0 == (total % (NUM_MSGS / 100))) | 100 | if (0 == (total % (NUM_MSGS / 100))) |
101 | fprintf (stderr, "%s", "."); | 101 | fprintf (stderr, "%s", "."); |
102 | #endif | 102 | #endif |
103 | /* tolerate 10% loss, i.e. due to duplicate fragment IDs */ | 103 | /* tolerate 10% loss, e.g due to duplicate fragment IDs */ |
104 | if ((total >= NUM_MSGS - (NUM_MSGS / 10)) && (ret != 0)) | 104 | if ((total >= NUM_MSGS - (NUM_MSGS / 10)) && (ret != 0)) |
105 | { | 105 | { |
106 | if (NULL == shutdown_task) | 106 | if (NULL == shutdown_task) |
diff --git a/src/fs/fs_directory.c b/src/fs/fs_directory.c index 9a198d8d7..9f0f12611 100644 --- a/src/fs/fs_directory.c +++ b/src/fs/fs_directory.c | |||
@@ -120,7 +120,7 @@ struct GetFullDataClosure | |||
120 | * | 120 | * |
121 | * @param cls closure (user-defined) | 121 | * @param cls closure (user-defined) |
122 | * @param plugin_name name of the plugin that produced this value; | 122 | * @param plugin_name name of the plugin that produced this value; |
123 | * special values can be used (i.e. '<zlib>' for zlib being | 123 | * special values can be used (e.g. '<zlib>' for zlib being |
124 | * used in the main libextractor library and yielding | 124 | * used in the main libextractor library and yielding |
125 | * meta data). | 125 | * meta data). |
126 | * @param type libextractor-type describing the meta data | 126 | * @param type libextractor-type describing the meta data |
diff --git a/src/fs/fs_download.c b/src/fs/fs_download.c index d4677b794..1f8ce7c05 100644 --- a/src/fs/fs_download.c +++ b/src/fs/fs_download.c | |||
@@ -586,7 +586,7 @@ try_match_block (struct GNUNET_FS_DownloadContext *dc, | |||
586 | * | 586 | * |
587 | * @param cls our 'struct GNUNET_FS_DownloadContext*' | 587 | * @param cls our 'struct GNUNET_FS_DownloadContext*' |
588 | * @param plugin_name name of the plugin that produced this value; | 588 | * @param plugin_name name of the plugin that produced this value; |
589 | * special values can be used (i.e. '<zlib>' for zlib being | 589 | * special values can be used (e.g. '<zlib>' for zlib being |
590 | * used in the main libextractor library and yielding | 590 | * used in the main libextractor library and yielding |
591 | * meta data). | 591 | * meta data). |
592 | * @param type libextractor-type describing the meta data | 592 | * @param type libextractor-type describing the meta data |
diff --git a/src/fs/fs_sharetree.c b/src/fs/fs_sharetree.c index ac850076d..d5e75f9be 100644 --- a/src/fs/fs_sharetree.c +++ b/src/fs/fs_sharetree.c | |||
@@ -183,7 +183,7 @@ add_to_keyword_counter (void *cls, const char *keyword, int is_mandatory) | |||
183 | * | 183 | * |
184 | * @param cls the container multihashmap to update | 184 | * @param cls the container multihashmap to update |
185 | * @param plugin_name name of the plugin that produced this value; | 185 | * @param plugin_name name of the plugin that produced this value; |
186 | * special values can be used (i.e. '<zlib>' for zlib being | 186 | * special values can be used (e.g. '<zlib>' for zlib being |
187 | * used in the main libextractor library and yielding | 187 | * used in the main libextractor library and yielding |
188 | * meta data). | 188 | * meta data). |
189 | * @param type libextractor-type describing the meta data | 189 | * @param type libextractor-type describing the meta data |
diff --git a/src/fs/fs_uri.c b/src/fs/fs_uri.c index a9afff3e8..4d1b7c6f0 100644 --- a/src/fs/fs_uri.c +++ b/src/fs/fs_uri.c | |||
@@ -1691,7 +1691,7 @@ get_keywords_from_tokens (const char *s, char **array, int index) | |||
1691 | * | 1691 | * |
1692 | * @param cls URI to update | 1692 | * @param cls URI to update |
1693 | * @param plugin_name name of the plugin that produced this value; | 1693 | * @param plugin_name name of the plugin that produced this value; |
1694 | * special values can be used (i.e. '<zlib>' for zlib being | 1694 | * special values can be used (e.g. '<zlib>' for zlib being |
1695 | * used in the main libextractor library and yielding | 1695 | * used in the main libextractor library and yielding |
1696 | * meta data). | 1696 | * meta data). |
1697 | * @param type libextractor-type describing the meta data | 1697 | * @param type libextractor-type describing the meta data |
diff --git a/src/fs/gnunet-helper-fs-publish.c b/src/fs/gnunet-helper-fs-publish.c index 5d2d1229b..ef1a9ce4b 100644 --- a/src/fs/gnunet-helper-fs-publish.c +++ b/src/fs/gnunet-helper-fs-publish.c | |||
@@ -100,7 +100,7 @@ static int output_stream; | |||
100 | * | 100 | * |
101 | * @param cls closure, our meta data container | 101 | * @param cls closure, our meta data container |
102 | * @param plugin_name name of the plugin that produced this value; | 102 | * @param plugin_name name of the plugin that produced this value; |
103 | * special values can be used (i.e. '<zlib>' for zlib being | 103 | * special values can be used (e.g. '<zlib>' for zlib being |
104 | * used in the main libextractor library and yielding | 104 | * used in the main libextractor library and yielding |
105 | * meta data). | 105 | * meta data). |
106 | * @param type libextractor-type describing the meta data | 106 | * @param type libextractor-type describing the meta data |
diff --git a/src/fs/gnunet-search.c b/src/fs/gnunet-search.c index e49609b18..3bf013650 100644 --- a/src/fs/gnunet-search.c +++ b/src/fs/gnunet-search.c | |||
@@ -64,7 +64,7 @@ static struct GNUNET_SCHEDULER_Task *tt; | |||
64 | * | 64 | * |
65 | * @param cls closure (user-defined, unused) | 65 | * @param cls closure (user-defined, unused) |
66 | * @param plugin_name name of the plugin that produced this value; | 66 | * @param plugin_name name of the plugin that produced this value; |
67 | * special values can be used (i.e. '<zlib>' for zlib being | 67 | * special values can be used (e.g. '<zlib>' for zlib being |
68 | * used in the main libextractor library and yielding | 68 | * used in the main libextractor library and yielding |
69 | * meta data). | 69 | * meta data). |
70 | * @param type libextractor-type describing the meta data | 70 | * @param type libextractor-type describing the meta data |
diff --git a/src/fs/perf_gnunet_service_fs_p2p_respect.c b/src/fs/perf_gnunet_service_fs_p2p_respect.c index b7fe61be7..c48db2383 100644 --- a/src/fs/perf_gnunet_service_fs_p2p_respect.c +++ b/src/fs/perf_gnunet_service_fs_p2p_respect.c | |||
@@ -21,7 +21,7 @@ | |||
21 | /** | 21 | /** |
22 | * @file fs/perf_gnunet_service_fs_p2p_respect.c | 22 | * @file fs/perf_gnunet_service_fs_p2p_respect.c |
23 | * @brief profile P2P routing respect mechanism. Creates | 23 | * @brief profile P2P routing respect mechanism. Creates |
24 | * a clique of NUM_DAEMONS (i.e. 3) where two | 24 | * a clique of NUM_DAEMONS (at least 3) where two |
25 | * peers share (seed) different files and download | 25 | * peers share (seed) different files and download |
26 | * them from each other while all the other peers | 26 | * them from each other while all the other peers |
27 | * just "leach" those files. Ideally, the seeders | 27 | * just "leach" those files. Ideally, the seeders |
diff --git a/src/gns/gns_tld_api.c b/src/gns/gns_tld_api.c index b883662ad..1b711cf40 100644 --- a/src/gns/gns_tld_api.c +++ b/src/gns/gns_tld_api.c | |||
@@ -235,7 +235,7 @@ identity_zone_cb (void *cls, | |||
235 | * @param options local options for the lookup | 235 | * @param options local options for the lookup |
236 | * @param proc processor to call on result | 236 | * @param proc processor to call on result |
237 | * @param proc_cls closure for @a proc | 237 | * @param proc_cls closure for @a proc |
238 | * @return handle to the get request, NULL on error (i.e. bad configuration) | 238 | * @return handle to the get request, NULL on error (e.g. bad configuration) |
239 | */ | 239 | */ |
240 | struct GNUNET_GNS_LookupWithTldRequest * | 240 | struct GNUNET_GNS_LookupWithTldRequest * |
241 | GNUNET_GNS_lookup_with_tld (struct GNUNET_GNS_Handle *handle, | 241 | GNUNET_GNS_lookup_with_tld (struct GNUNET_GNS_Handle *handle, |
diff --git a/src/gns/gnunet-gns-import.c b/src/gns/gnunet-gns-import.c index 972fb49cd..e99c4d3dd 100644 --- a/src/gns/gnunet-gns-import.c +++ b/src/gns/gnunet-gns-import.c | |||
@@ -272,13 +272,12 @@ zone_iteration_finished (void *cls) | |||
272 | * with 'NULL' for 'ego'. That does NOT mean that the callback won't | 272 | * with 'NULL' for 'ego'. That does NOT mean that the callback won't |
273 | * be invoked in the future or that there was an error. | 273 | * be invoked in the future or that there was an error. |
274 | * | 274 | * |
275 | * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', | 275 | * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', this |
276 | * this function is only called ONCE, and 'NULL' being passed in | 276 | * function is only called ONCE, and 'NULL' being passed in 'ego' does |
277 | * 'ego' does indicate an error (i.e. name is taken or no default | 277 | * indicate an error (for example because name is taken or no default value is |
278 | * value is known). If 'ego' is non-NULL and if '*ctx' | 278 | * known). If 'ego' is non-NULL and if '*ctx' is set in those callbacks, the |
279 | * is set in those callbacks, the value WILL be passed to a subsequent | 279 | * value WILL be passed to a subsequent call to the identity callback of |
280 | * call to the identity callback of 'GNUNET_IDENTITY_connect' (if | 280 | * 'GNUNET_IDENTITY_connect' (if that one was not NULL). |
281 | * that one was not NULL). | ||
282 | * | 281 | * |
283 | * When an identity is renamed, this function is called with the | 282 | * When an identity is renamed, this function is called with the |
284 | * (known) ego but the NEW identifier. | 283 | * (known) ego but the NEW identifier. |
diff --git a/src/gns/gnunet-gns-proxy-ca.template b/src/gns/gnunet-gns-proxy-ca.template index 32ee27fcd..541e3a355 100644 --- a/src/gns/gnunet-gns-proxy-ca.template +++ b/src/gns/gnunet-gns-proxy-ca.template | |||
@@ -51,7 +51,7 @@ cn = "GNS Proxy CA" | |||
51 | #dn = "cn = Nikos,st = New\, Something,C=GR,surName=Mavrogiannopoulos,2.5.4.9=Arkadias" | 51 | #dn = "cn = Nikos,st = New\, Something,C=GR,surName=Mavrogiannopoulos,2.5.4.9=Arkadias" |
52 | 52 | ||
53 | # The serial number of the certificate | 53 | # The serial number of the certificate |
54 | # The value is in decimal (i.e. 1963) or hex (i.e. 0x07ab). | 54 | # The value is in decimal (e.g. 1963) or hex (e.g. 0x07ab). |
55 | # Comment the field for a random serial number. | 55 | # Comment the field for a random serial number. |
56 | #serial = 007 | 56 | #serial = 007 |
57 | 57 | ||
@@ -283,7 +283,7 @@ tls_www_server | |||
283 | #crl_next_update = 43 | 283 | #crl_next_update = 43 |
284 | 284 | ||
285 | # this is the 5th CRL by this CA | 285 | # this is the 5th CRL by this CA |
286 | # The value is in decimal (i.e. 1963) or hex (i.e. 0x07ab). | 286 | # The value is in decimal (e.g. 1963) or hex (e.g. 0x07ab). |
287 | # Comment the field for a time-based number. | 287 | # Comment the field for a time-based number. |
288 | # Time-based CRL numbers generated in GnuTLS 3.6.3 and later | 288 | # Time-based CRL numbers generated in GnuTLS 3.6.3 and later |
289 | # are significantly larger than those generated in previous | 289 | # are significantly larger than those generated in previous |
diff --git a/src/gns/gnunet-gns-proxy.c b/src/gns/gnunet-gns-proxy.c index d02f0f576..5e3f9d6df 100644 --- a/src/gns/gnunet-gns-proxy.c +++ b/src/gns/gnunet-gns-proxy.c | |||
@@ -1811,7 +1811,7 @@ con_val_iter (void *cls, | |||
1811 | * @param con MHD connection handle | 1811 | * @param con MHD connection handle |
1812 | * @param url the url in the request | 1812 | * @param url the url in the request |
1813 | * @param meth the HTTP method used ("GET", "PUT", etc.) | 1813 | * @param meth the HTTP method used ("GET", "PUT", etc.) |
1814 | * @param ver the HTTP version string (i.e. "HTTP/1.1") | 1814 | * @param ver the HTTP version string ("HTTP/1.1" for version 1.1, etc.) |
1815 | * @param upload_data the data being uploaded (excluding HEADERS, | 1815 | * @param upload_data the data being uploaded (excluding HEADERS, |
1816 | * for a POST that fits into memory and that is encoded | 1816 | * for a POST that fits into memory and that is encoded |
1817 | * with a supported encoding, the POST data will NOT be | 1817 | * with a supported encoding, the POST data will NOT be |
@@ -2855,7 +2855,7 @@ lookup_ssl_httpd (const char*domain) | |||
2855 | 2855 | ||
2856 | /** | 2856 | /** |
2857 | * Task run when a Socks5Request somehow fails to be associated with | 2857 | * Task run when a Socks5Request somehow fails to be associated with |
2858 | * an MHD connection (i.e. because the client never speaks HTTP after | 2858 | * an MHD connection (e.g. because the client never speaks HTTP after |
2859 | * the SOCKS5 handshake). Clean up. | 2859 | * the SOCKS5 handshake). Clean up. |
2860 | * | 2860 | * |
2861 | * @param cls the `struct Socks5Request *` | 2861 | * @param cls the `struct Socks5Request *` |
diff --git a/src/gns/gnunet-service-gns.c b/src/gns/gnunet-service-gns.c index 52300ae3b..5833f4d0b 100644 --- a/src/gns/gnunet-service-gns.c +++ b/src/gns/gnunet-service-gns.c | |||
@@ -104,7 +104,7 @@ struct GnsClient | |||
104 | 104 | ||
105 | /** | 105 | /** |
106 | * Representation of a TLD, mapping the respective TLD string | 106 | * Representation of a TLD, mapping the respective TLD string |
107 | * (i.e. ".gnu") to the respective public key of the zone. | 107 | * (e.g. ".gnu") to the respective public key of the zone. |
108 | */ | 108 | */ |
109 | struct GNS_TopLevelDomain | 109 | struct GNS_TopLevelDomain |
110 | { | 110 | { |
diff --git a/src/gns/gnunet-service-gns_resolver.c b/src/gns/gnunet-service-gns_resolver.c index 2f8a55804..784a6ee6d 100644 --- a/src/gns/gnunet-service-gns_resolver.c +++ b/src/gns/gnunet-service-gns_resolver.c | |||
@@ -418,7 +418,7 @@ struct GNS_ResolverHandle | |||
418 | 418 | ||
419 | /** | 419 | /** |
420 | * We increment the loop limiter for each step in a recursive | 420 | * We increment the loop limiter for each step in a recursive |
421 | * resolution. If it passes our @e loop_threshold (i.e. due to | 421 | * resolution. If it passes our @e loop_threshold (e.g. due to |
422 | * self-recursion in the resolution, i.e CNAME fun), we stop. | 422 | * self-recursion in the resolution, i.e CNAME fun), we stop. |
423 | */ | 423 | */ |
424 | unsigned int loop_limiter; | 424 | unsigned int loop_limiter; |
@@ -516,7 +516,7 @@ static const struct GNUNET_CONFIGURATION_Handle *cfg; | |||
516 | /** | 516 | /** |
517 | * Determine if this name is canonical (is a legal name in a zone, without delegation); | 517 | * Determine if this name is canonical (is a legal name in a zone, without delegation); |
518 | * note that we do not test that the name does not contain illegal characters, we only | 518 | * note that we do not test that the name does not contain illegal characters, we only |
519 | * test for delegation. Note that service records (i.e. _foo._srv) are canonical names | 519 | * test for delegation. Note that service records (like _foo._srv) are canonical names |
520 | * even though they consist of multiple labels. | 520 | * even though they consist of multiple labels. |
521 | * | 521 | * |
522 | * Examples: | 522 | * Examples: |
diff --git a/src/gns/plugin_gnsrecord_gns.c b/src/gns/plugin_gnsrecord_gns.c index a2ad0b905..391144925 100644 --- a/src/gns/plugin_gnsrecord_gns.c +++ b/src/gns/plugin_gnsrecord_gns.c | |||
@@ -327,7 +327,7 @@ static struct | |||
327 | 327 | ||
328 | 328 | ||
329 | /** | 329 | /** |
330 | * Convert a type name (i.e. "AAAA") to the corresponding number. | 330 | * Convert a type name (e.g. "AAAA") to the corresponding number. |
331 | * | 331 | * |
332 | * @param cls closure, unused | 332 | * @param cls closure, unused |
333 | * @param gns_typename name to convert | 333 | * @param gns_typename name to convert |
@@ -347,7 +347,7 @@ gns_typename_to_number (void *cls, const char *gns_typename) | |||
347 | 347 | ||
348 | 348 | ||
349 | /** | 349 | /** |
350 | * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") | 350 | * Convert a type number to the corresponding type string (e.g. 1 to "A") |
351 | * | 351 | * |
352 | * @param cls closure, unused | 352 | * @param cls closure, unused |
353 | * @param type number of a type to convert | 353 | * @param type number of a type to convert |
diff --git a/src/gnsrecord/gnsrecord.c b/src/gnsrecord/gnsrecord.c index 31749a629..e9994a868 100644 --- a/src/gnsrecord/gnsrecord.c +++ b/src/gnsrecord/gnsrecord.c | |||
@@ -208,7 +208,7 @@ GNUNET_GNSRECORD_string_to_value (uint32_t type, | |||
208 | 208 | ||
209 | 209 | ||
210 | /** | 210 | /** |
211 | * Convert a type name (i.e. "AAAA") to the corresponding number. | 211 | * Convert a type name (e.g "AAAA") to the corresponding number. |
212 | * | 212 | * |
213 | * @param dns_typename name to convert | 213 | * @param dns_typename name to convert |
214 | * @return corresponding number, UINT32_MAX on error | 214 | * @return corresponding number, UINT32_MAX on error |
@@ -235,7 +235,7 @@ GNUNET_GNSRECORD_typename_to_number (const char *dns_typename) | |||
235 | 235 | ||
236 | 236 | ||
237 | /** | 237 | /** |
238 | * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") | 238 | * Convert a type number to the corresponding type string (e.g. 1 to "A") |
239 | * | 239 | * |
240 | * @param type number of a type to convert | 240 | * @param type number of a type to convert |
241 | * @return corresponding typestring, NULL on error | 241 | * @return corresponding typestring, NULL on error |
diff --git a/src/gnsrecord/plugin_gnsrecord_dns.c b/src/gnsrecord/plugin_gnsrecord_dns.c index bde9944e2..123c59905 100644 --- a/src/gnsrecord/plugin_gnsrecord_dns.c +++ b/src/gnsrecord/plugin_gnsrecord_dns.c | |||
@@ -735,7 +735,7 @@ static struct | |||
735 | 735 | ||
736 | 736 | ||
737 | /** | 737 | /** |
738 | * Convert a type name (i.e. "AAAA") to the corresponding number. | 738 | * Convert a type name (e.g. "AAAA") to the corresponding number. |
739 | * | 739 | * |
740 | * @param cls closure, unused | 740 | * @param cls closure, unused |
741 | * @param dns_typename name to convert | 741 | * @param dns_typename name to convert |
@@ -755,7 +755,7 @@ dns_typename_to_number (void *cls, const char *dns_typename) | |||
755 | 755 | ||
756 | 756 | ||
757 | /** | 757 | /** |
758 | * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") | 758 | * Convert a type number to the corresponding type string (e.g. 1 to "A") |
759 | * | 759 | * |
760 | * @param cls closure, unused | 760 | * @param cls closure, unused |
761 | * @param type number of a type to convert | 761 | * @param type number of a type to convert |
diff --git a/src/hostlist/gnunet-daemon-hostlist_server.c b/src/hostlist/gnunet-daemon-hostlist_server.c index b6c0495c0..fb80f6331 100644 --- a/src/hostlist/gnunet-daemon-hostlist_server.c +++ b/src/hostlist/gnunet-daemon-hostlist_server.c | |||
@@ -320,7 +320,7 @@ accept_policy_callback (void *cls, | |||
320 | * @param url the requested url | 320 | * @param url the requested url |
321 | * @param method the HTTP method used (#MHD_HTTP_METHOD_GET, | 321 | * @param method the HTTP method used (#MHD_HTTP_METHOD_GET, |
322 | * #MHD_HTTP_METHOD_PUT, etc.) | 322 | * #MHD_HTTP_METHOD_PUT, etc.) |
323 | * @param version the HTTP version string (i.e. | 323 | * @param version the HTTP version string (e.g. |
324 | * #MHD_HTTP_VERSION_1_1) | 324 | * #MHD_HTTP_VERSION_1_1) |
325 | * @param upload_data the data being uploaded (excluding HEADERS, | 325 | * @param upload_data the data being uploaded (excluding HEADERS, |
326 | * for a POST that fits into memory and that is encoded | 326 | * for a POST that fits into memory and that is encoded |
@@ -335,7 +335,7 @@ accept_policy_callback (void *cls, | |||
335 | * @param con_cls pointer that the callback can set to some | 335 | * @param con_cls pointer that the callback can set to some |
336 | * address and that will be preserved by MHD for future | 336 | * address and that will be preserved by MHD for future |
337 | * calls for this request; since the access handler may | 337 | * calls for this request; since the access handler may |
338 | * be called many times (i.e., for a PUT/POST operation | 338 | * be called many times (e.g. for a PUT/POST operation |
339 | * with plenty of upload data) this allows the application | 339 | * with plenty of upload data) this allows the application |
340 | * to easily associate some request-specific state. | 340 | * to easily associate some request-specific state. |
341 | * If necessary, this state can be cleaned up in the | 341 | * If necessary, this state can be cleaned up in the |
diff --git a/src/identity/gnunet-identity.c b/src/identity/gnunet-identity.c index a01cd1ed7..d8dc936d3 100644 --- a/src/identity/gnunet-identity.c +++ b/src/identity/gnunet-identity.c | |||
@@ -268,13 +268,12 @@ set_done (void *cls, const char *emsg) | |||
268 | * with 'NULL' for 'ego'. That does NOT mean that the callback won't | 268 | * with 'NULL' for 'ego'. That does NOT mean that the callback won't |
269 | * be invoked in the future or that there was an error. | 269 | * be invoked in the future or that there was an error. |
270 | * | 270 | * |
271 | * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', | 271 | * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', this |
272 | * this function is only called ONCE, and 'NULL' being passed in | 272 | * function is only called ONCE, and 'NULL' being passed in 'ego' does |
273 | * 'ego' does indicate an error (i.e. name is taken or no default | 273 | * indicate an error (for example because name is taken or no default value is |
274 | * value is known). If 'ego' is non-NULL and if '*ctx' | 274 | * known). If 'ego' is non-NULL and if '*ctx' is set in those callbacks, the |
275 | * is set in those callbacks, the value WILL be passed to a subsequent | 275 | * value WILL be passed to a subsequent call to the identity callback of |
276 | * call to the identity callback of 'GNUNET_IDENTITY_connect' (if | 276 | * 'GNUNET_IDENTITY_connect' (if that one was not NULL). |
277 | * that one was not NULL). | ||
278 | * | 277 | * |
279 | * When an identity is renamed, this function is called with the | 278 | * When an identity is renamed, this function is called with the |
280 | * (known) ego but the NEW identifier. | 279 | * (known) ego but the NEW identifier. |
diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h index 92572c72b..68ba8e6b2 100644 --- a/src/include/gnunet_ats_service.h +++ b/src/include/gnunet_ats_service.h | |||
@@ -94,7 +94,7 @@ struct GNUNET_ATS_Properties | |||
94 | 94 | ||
95 | /** | 95 | /** |
96 | * Distance on network layer (required for distance-vector routing) | 96 | * Distance on network layer (required for distance-vector routing) |
97 | * in hops. Zero for direct connections (i.e. plain TCP/UDP). | 97 | * in hops. Zero for direct connections (e.g. plain TCP/UDP). |
98 | */ | 98 | */ |
99 | unsigned int distance; | 99 | unsigned int distance; |
100 | 100 | ||
@@ -136,7 +136,7 @@ struct GNUNET_ATS_PropertiesNBO | |||
136 | 136 | ||
137 | /** | 137 | /** |
138 | * Distance on network layer (required for distance-vector routing) | 138 | * Distance on network layer (required for distance-vector routing) |
139 | * in hops. Zero for direct connections (i.e. plain TCP/UDP). | 139 | * in hops. Zero for direct connections (e.g. plain TCP/UDP). |
140 | */ | 140 | */ |
141 | uint32_t distance GNUNET_PACKED; | 141 | uint32_t distance GNUNET_PACKED; |
142 | 142 | ||
@@ -308,7 +308,7 @@ struct GNUNET_ATS_AddressRecord; | |||
308 | * | 308 | * |
309 | * @param sh handle | 309 | * @param sh handle |
310 | * @param address the address | 310 | * @param address the address |
311 | * @param session session handle (if available, i.e. for incoming connections) | 311 | * @param session session handle (if available, e.g for incoming connections) |
312 | * @param prop performance data for the address | 312 | * @param prop performance data for the address |
313 | * @return handle to the address representation inside ATS, NULL | 313 | * @return handle to the address representation inside ATS, NULL |
314 | * on error (i.e. ATS knows this exact address already, or | 314 | * on error (i.e. ATS knows this exact address already, or |
diff --git a/src/include/gnunet_ats_transport_service.h b/src/include/gnunet_ats_transport_service.h index b5848a36a..fd821baef 100644 --- a/src/include/gnunet_ats_transport_service.h +++ b/src/include/gnunet_ats_transport_service.h | |||
@@ -85,7 +85,7 @@ struct GNUNET_ATS_Properties | |||
85 | 85 | ||
86 | /** | 86 | /** |
87 | * Distance on network layer (required for distance-vector routing) | 87 | * Distance on network layer (required for distance-vector routing) |
88 | * in hops. Zero for direct connections (i.e. plain TCP/UDP). | 88 | * in hops. Zero for direct connections (e.g. plain TCP/UDP). |
89 | */ | 89 | */ |
90 | uint32_t distance; | 90 | uint32_t distance; |
91 | 91 | ||
diff --git a/src/include/gnunet_client_lib.h b/src/include/gnunet_client_lib.h index aaa1f4a74..2ecd38b04 100644 --- a/src/include/gnunet_client_lib.h +++ b/src/include/gnunet_client_lib.h | |||
@@ -56,7 +56,7 @@ extern "C" | |||
56 | * #GNUNET_NO if the service is (definitively) down, | 56 | * #GNUNET_NO if the service is (definitively) down, |
57 | * #GNUNET_SYSERR if the configuration does not give us | 57 | * #GNUNET_SYSERR if the configuration does not give us |
58 | * the necessary information about the service, or if | 58 | * the necessary information about the service, or if |
59 | * we could not check (i.e. socket() failed) | 59 | * we could not check (e.g. socket() failed) |
60 | */ | 60 | */ |
61 | int | 61 | int |
62 | GNUNET_CLIENT_test (const struct GNUNET_CONFIGURATION_Handle *cfg, | 62 | GNUNET_CLIENT_test (const struct GNUNET_CONFIGURATION_Handle *cfg, |
diff --git a/src/include/gnunet_container_lib.h b/src/include/gnunet_container_lib.h index 0d81abfd3..c8930746d 100644 --- a/src/include/gnunet_container_lib.h +++ b/src/include/gnunet_container_lib.h | |||
@@ -161,7 +161,7 @@ enum EXTRACTOR_MetaFormat | |||
161 | * | 161 | * |
162 | * @param cls closure (user-defined) | 162 | * @param cls closure (user-defined) |
163 | * @param plugin_name name of the plugin that produced this value; | 163 | * @param plugin_name name of the plugin that produced this value; |
164 | * special values can be used (i.e. '<zlib>' for zlib being | 164 | * special values can be used (e.g. '<zlib>' for zlib being |
165 | * used in the main libextractor library and yielding | 165 | * used in the main libextractor library and yielding |
166 | * meta data). | 166 | * meta data). |
167 | * @param type libextractor-type describing the meta data | 167 | * @param type libextractor-type describing the meta data |
@@ -484,7 +484,7 @@ GNUNET_CONTAINER_meta_data_test_equal ( | |||
484 | * | 484 | * |
485 | * @param md metadata to extend | 485 | * @param md metadata to extend |
486 | * @param plugin_name name of the plugin that produced this value; | 486 | * @param plugin_name name of the plugin that produced this value; |
487 | * special values can be used (i.e. '<zlib>' for zlib being | 487 | * special values can be used (e.g. '<zlib>' for zlib being |
488 | * used in the main libextractor library and yielding | 488 | * used in the main libextractor library and yielding |
489 | * meta data). | 489 | * meta data). |
490 | * @param type libextractor-type describing the meta data | 490 | * @param type libextractor-type describing the meta data |
@@ -693,7 +693,7 @@ GNUNET_CONTAINER_meta_data_get_serialized_size ( | |||
693 | * | 693 | * |
694 | * @param input serialized meta-data. | 694 | * @param input serialized meta-data. |
695 | * @param size number of bytes available | 695 | * @param size number of bytes available |
696 | * @return MD on success, NULL on error (i.e. | 696 | * @return MD on success, NULL on error (e.g. |
697 | * bad format) | 697 | * bad format) |
698 | */ | 698 | */ |
699 | struct GNUNET_CONTAINER_MetaData * | 699 | struct GNUNET_CONTAINER_MetaData * |
@@ -2441,7 +2441,7 @@ GNUNET_CONTAINER_multihashmap32_iterator_destroy ( | |||
2441 | * Insertion sort of @a element into DLL from @a head to @a tail | 2441 | * Insertion sort of @a element into DLL from @a head to @a tail |
2442 | * sorted by @a comparator. | 2442 | * sorted by @a comparator. |
2443 | * | 2443 | * |
2444 | * @param TYPE element type of the elements, i.e. `struct ListElement` | 2444 | * @param TYPE element type of the elements, e.g. `struct ListElement` |
2445 | * @param comparator function like memcmp() to compare elements; takes | 2445 | * @param comparator function like memcmp() to compare elements; takes |
2446 | * three arguments, the @a comparator_cls and two elements, | 2446 | * three arguments, the @a comparator_cls and two elements, |
2447 | * returns an `int` (-1, 0 or 1) | 2447 | * returns an `int` (-1, 0 or 1) |
diff --git a/src/include/gnunet_crypto_lib.h b/src/include/gnunet_crypto_lib.h index 2a552e212..43cdfdfac 100644 --- a/src/include/gnunet_crypto_lib.h +++ b/src/include/gnunet_crypto_lib.h | |||
@@ -945,7 +945,7 @@ GNUNET_CRYPTO_hash_get_bit_rtl (const struct GNUNET_HashCode *code, | |||
945 | /** | 945 | /** |
946 | * @ingroup hash | 946 | * @ingroup hash |
947 | * Determine how many low order bits match in two | 947 | * Determine how many low order bits match in two |
948 | * `struct GNUNET_HashCodes`. i.e. - 010011 and 011111 share | 948 | * `struct GNUNET_HashCodes`. e.g. - 010011 and 011111 share |
949 | * the first two lowest order bits, and therefore the | 949 | * the first two lowest order bits, and therefore the |
950 | * return value is two (NOT XOR distance, nor how many | 950 | * return value is two (NOT XOR distance, nor how many |
951 | * bits match absolutely!). | 951 | * bits match absolutely!). |
@@ -2048,7 +2048,7 @@ struct GNUNET_CRYPTO_RsaSignature; | |||
2048 | /** | 2048 | /** |
2049 | * Create a new private key. Caller must free return value. | 2049 | * Create a new private key. Caller must free return value. |
2050 | * | 2050 | * |
2051 | * @param len length of the key in bits (i.e. 2048) | 2051 | * @param len length of the key in bits (e.g. 2048) |
2052 | * @return fresh private key | 2052 | * @return fresh private key |
2053 | */ | 2053 | */ |
2054 | struct GNUNET_CRYPTO_RsaPrivateKey * | 2054 | struct GNUNET_CRYPTO_RsaPrivateKey * |
diff --git a/src/include/gnunet_curl_lib.h b/src/include/gnunet_curl_lib.h index f291d6b14..f51e4b503 100644 --- a/src/include/gnunet_curl_lib.h +++ b/src/include/gnunet_curl_lib.h | |||
@@ -68,7 +68,7 @@ struct GNUNET_CURL_DownloadBuffer | |||
68 | 68 | ||
69 | /** | 69 | /** |
70 | * Error code (based on libc errno) if we failed to download | 70 | * Error code (based on libc errno) if we failed to download |
71 | * (i.e. response too large). | 71 | * (e.g. response too large). |
72 | */ | 72 | */ |
73 | int eno; | 73 | int eno; |
74 | }; | 74 | }; |
diff --git a/src/include/gnunet_dht_service.h b/src/include/gnunet_dht_service.h index ea3ea92fa..95d30ae6f 100644 --- a/src/include/gnunet_dht_service.h +++ b/src/include/gnunet_dht_service.h | |||
@@ -178,7 +178,7 @@ GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle, | |||
178 | * has not yet been sent to the service, cancelling the PUT will stop | 178 | * has not yet been sent to the service, cancelling the PUT will stop |
179 | * this from happening (but there is no way for the user of this API | 179 | * this from happening (but there is no way for the user of this API |
180 | * to tell if that is the case). The only use for this API is to | 180 | * to tell if that is the case). The only use for this API is to |
181 | * prevent a later call to 'cont' from #GNUNET_DHT_put (i.e. because | 181 | * prevent a later call to 'cont' from #GNUNET_DHT_put (e.g. because |
182 | * the system is shutting down). | 182 | * the system is shutting down). |
183 | * | 183 | * |
184 | * @param ph put operation to cancel ('cont' will no longer be called) | 184 | * @param ph put operation to cancel ('cont' will no longer be called) |
diff --git a/src/include/gnunet_getopt_lib.h b/src/include/gnunet_getopt_lib.h index b37827ccc..731be4159 100644 --- a/src/include/gnunet_getopt_lib.h +++ b/src/include/gnunet_getopt_lib.h | |||
@@ -83,7 +83,7 @@ struct GNUNET_GETOPT_CommandLineProcessorContext | |||
83 | * | 83 | * |
84 | * @param ctx context for all options | 84 | * @param ctx context for all options |
85 | * @param scls specific closure (for this processor) | 85 | * @param scls specific closure (for this processor) |
86 | * @param option long name of the option (i.e. "config" for --config) | 86 | * @param option long name of the option (e.g. "config" for --config) |
87 | * @param value argument, NULL if none was given | 87 | * @param value argument, NULL if none was given |
88 | * @return #GNUNET_OK to continue processing other options, #GNUNET_SYSERR to abort | 88 | * @return #GNUNET_OK to continue processing other options, #GNUNET_SYSERR to abort |
89 | */ | 89 | */ |
diff --git a/src/include/gnunet_gnsrecord_lib.h b/src/include/gnunet_gnsrecord_lib.h index aff56146e..61cbac2ca 100644 --- a/src/include/gnunet_gnsrecord_lib.h +++ b/src/include/gnunet_gnsrecord_lib.h | |||
@@ -308,7 +308,7 @@ GNUNET_GNSRECORD_string_to_value (uint32_t type, const char *s, void **data, | |||
308 | 308 | ||
309 | 309 | ||
310 | /** | 310 | /** |
311 | * Convert a type name (i.e. "AAAA") to the corresponding number. | 311 | * Convert a type name (e.g. "AAAA") to the corresponding number. |
312 | * | 312 | * |
313 | * @param dns_typename name to convert | 313 | * @param dns_typename name to convert |
314 | * @return corresponding number, UINT32_MAX on error | 314 | * @return corresponding number, UINT32_MAX on error |
@@ -318,7 +318,7 @@ GNUNET_GNSRECORD_typename_to_number (const char *dns_typename); | |||
318 | 318 | ||
319 | 319 | ||
320 | /** | 320 | /** |
321 | * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") | 321 | * Convert a type number to the corresponding type string (e.g. 1 to "A") |
322 | * | 322 | * |
323 | * @param type number of a type to convert | 323 | * @param type number of a type to convert |
324 | * @return corresponding typestring, NULL on error | 324 | * @return corresponding typestring, NULL on error |
diff --git a/src/include/gnunet_gnsrecord_plugin.h b/src/include/gnunet_gnsrecord_plugin.h index 1435bc4b3..aec22c3af 100644 --- a/src/include/gnunet_gnsrecord_plugin.h +++ b/src/include/gnunet_gnsrecord_plugin.h | |||
@@ -81,7 +81,7 @@ typedef int | |||
81 | 81 | ||
82 | 82 | ||
83 | /** | 83 | /** |
84 | * Function called to convert a type name (i.e. "AAAA") to the | 84 | * Function called to convert a type name (e.g. "AAAA") to the |
85 | * corresponding number. | 85 | * corresponding number. |
86 | * | 86 | * |
87 | * @param cls closure | 87 | * @param cls closure |
@@ -94,8 +94,8 @@ typedef uint32_t | |||
94 | 94 | ||
95 | 95 | ||
96 | /** | 96 | /** |
97 | * Function called to convert a type number (i.e. 1) to the | 97 | * Function called to convert a type number to the |
98 | * corresponding type string (i.e. "A") | 98 | * corresponding type string (e.g. 1 to "A") |
99 | * | 99 | * |
100 | * @param cls closure | 100 | * @param cls closure |
101 | * @param type number of a type to convert | 101 | * @param type number of a type to convert |
diff --git a/src/include/gnunet_identity_service.h b/src/include/gnunet_identity_service.h index 2974568db..c123983e2 100644 --- a/src/include/gnunet_identity_service.h +++ b/src/include/gnunet_identity_service.h | |||
@@ -210,13 +210,12 @@ GNUNET_IDENTITY_ego_get_public_key (struct GNUNET_IDENTITY_Ego *ego, | |||
210 | * with 'NULL' for @a ego. That does NOT mean that the callback won't | 210 | * with 'NULL' for @a ego. That does NOT mean that the callback won't |
211 | * be invoked in the future or that there was an error. | 211 | * be invoked in the future or that there was an error. |
212 | * | 212 | * |
213 | * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, | 213 | * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, this |
214 | * this function is only called ONCE, and 'NULL' being passed in | 214 | * function is only called ONCE, and 'NULL' being passed in @a ego does |
215 | * @a ego does indicate an error (i.e. name is taken or no default | 215 | * indicate an error (for example because name is taken or no default value is |
216 | * value is known). If @a ego is non-NULL and if '*ctx' | 216 | * known). If @a ego is non-NULL and if '*ctx' is set in those callbacks, the |
217 | * is set in those callbacks, the value WILL be passed to a subsequent | 217 | * value WILL be passed to a subsequent call to the identity callback of |
218 | * call to the identity callback of #GNUNET_IDENTITY_connect (if | 218 | * #GNUNET_IDENTITY_connect (if that one was not NULL). |
219 | * that one was not NULL). | ||
220 | * | 219 | * |
221 | * When an identity is renamed, this function is called with the | 220 | * When an identity is renamed, this function is called with the |
222 | * (known) @a ego but the NEW @a name. | 221 | * (known) @a ego but the NEW @a name. |
@@ -768,7 +767,7 @@ struct GNUNET_IDENTITY_EgoSuffixLookup; | |||
768 | 767 | ||
769 | /** | 768 | /** |
770 | * Obtain the ego with the maximum suffix match between the | 769 | * Obtain the ego with the maximum suffix match between the |
771 | * ego's name and the given domain name @a suffix. I.e., given | 770 | * ego's name and the given domain name @a suffix. For example, given |
772 | * a @a suffix "a.b.c" and egos with names "d.a.b.c", "b.c" and "c", | 771 | * a @a suffix "a.b.c" and egos with names "d.a.b.c", "b.c" and "c", |
773 | * we return the ego for "b.c". | 772 | * we return the ego for "b.c". |
774 | * | 773 | * |
diff --git a/src/include/gnunet_mq_lib.h b/src/include/gnunet_mq_lib.h index 710664fe7..37bba8c1b 100644 --- a/src/include/gnunet_mq_lib.h +++ b/src/include/gnunet_mq_lib.h | |||
@@ -227,23 +227,23 @@ enum GNUNET_MQ_Error | |||
227 | enum GNUNET_MQ_PriorityPreferences | 227 | enum GNUNET_MQ_PriorityPreferences |
228 | { | 228 | { |
229 | /** | 229 | /** |
230 | * Lowest priority, i.e. background traffic (i.e. NSE, FS). | 230 | * Lowest priority, i.e. background traffic (e.g. NSE, FS). |
231 | * This is the default! | 231 | * This is the default! |
232 | */ | 232 | */ |
233 | GNUNET_MQ_PRIO_BACKGROUND = 0, | 233 | GNUNET_MQ_PRIO_BACKGROUND = 0, |
234 | 234 | ||
235 | /** | 235 | /** |
236 | * Best-effort traffic (i.e. CADET relay, DHT) | 236 | * Best-effort traffic (e.g. CADET relay, DHT) |
237 | */ | 237 | */ |
238 | GNUNET_MQ_PRIO_BEST_EFFORT = 1, | 238 | GNUNET_MQ_PRIO_BEST_EFFORT = 1, |
239 | 239 | ||
240 | /** | 240 | /** |
241 | * Urgent traffic (local peer, i.e. Conversation). | 241 | * Urgent traffic (local peer, e.g. Conversation). |
242 | */ | 242 | */ |
243 | GNUNET_MQ_PRIO_URGENT = 2, | 243 | GNUNET_MQ_PRIO_URGENT = 2, |
244 | 244 | ||
245 | /** | 245 | /** |
246 | * Highest priority, control traffic (i.e. CORE/CADET KX). | 246 | * Highest priority, control traffic (e.g. CORE/CADET KX). |
247 | */ | 247 | */ |
248 | GNUNET_MQ_PRIO_CRITICAL_CONTROL = 3, | 248 | GNUNET_MQ_PRIO_CRITICAL_CONTROL = 3, |
249 | 249 | ||
diff --git a/src/include/gnunet_network_lib.h b/src/include/gnunet_network_lib.h index e40dacde7..97ab64add 100644 --- a/src/include/gnunet_network_lib.h +++ b/src/include/gnunet_network_lib.h | |||
@@ -561,7 +561,7 @@ GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds); | |||
561 | /** | 561 | /** |
562 | * Test if the given @a port is available. | 562 | * Test if the given @a port is available. |
563 | * | 563 | * |
564 | * @param ipproto transport protocol to test (i.e. IPPROTO_TCP) | 564 | * @param ipproto transport protocol to test (e.g. IPPROTO_TCP) |
565 | * @param port port number to test | 565 | * @param port port number to test |
566 | * @return #GNUNET_OK if the port is available, #GNUNET_NO if not | 566 | * @return #GNUNET_OK if the port is available, #GNUNET_NO if not |
567 | */ | 567 | */ |
diff --git a/src/include/gnunet_reclaim_plugin.h b/src/include/gnunet_reclaim_plugin.h index 2ba8fc8a0..11d5d76f7 100644 --- a/src/include/gnunet_reclaim_plugin.h +++ b/src/include/gnunet_reclaim_plugin.h | |||
@@ -92,8 +92,8 @@ typedef uint32_t (*GNUNET_RECLAIM_AttributeTypenameToNumberFunction) ( | |||
92 | 92 | ||
93 | 93 | ||
94 | /** | 94 | /** |
95 | * Function called to convert a type number (i.e. 1) to the | 95 | * Function called to convert a type number to the |
96 | * corresponding type string | 96 | * corresponding type string (e.g. 1 to "A") |
97 | * | 97 | * |
98 | * @param cls closure | 98 | * @param cls closure |
99 | * @param type number of a type to convert | 99 | * @param type number of a type to convert |
@@ -154,8 +154,8 @@ typedef uint32_t (*GNUNET_RECLAIM_CredentialTypenameToNumberFunction) ( | |||
154 | 154 | ||
155 | 155 | ||
156 | /** | 156 | /** |
157 | * Function called to convert a type number (i.e. 1) to the | 157 | * Function called to convert a type number to the |
158 | * corresponding type string | 158 | * corresponding type string (e.g. 1 to "A") |
159 | * | 159 | * |
160 | * @param cls closure | 160 | * @param cls closure |
161 | * @param type number of a type to convert | 161 | * @param type number of a type to convert |
@@ -253,8 +253,8 @@ typedef uint32_t (*GNUNET_RECLAIM_PresentationTypenameToNumberFunction) ( | |||
253 | 253 | ||
254 | 254 | ||
255 | /** | 255 | /** |
256 | * Function called to convert a type number (i.e. 1) to the | 256 | * Function called to convert a type number to the |
257 | * corresponding type string | 257 | * corresponding type string (e.g. 1 to "A") |
258 | * | 258 | * |
259 | * @param cls closure | 259 | * @param cls closure |
260 | * @param type number of a type to convert | 260 | * @param type number of a type to convert |
diff --git a/src/include/gnunet_strings_lib.h b/src/include/gnunet_strings_lib.h index cc655d0b0..955a3afca 100644 --- a/src/include/gnunet_strings_lib.h +++ b/src/include/gnunet_strings_lib.h | |||
@@ -59,7 +59,7 @@ extern "C" | |||
59 | /** | 59 | /** |
60 | * Convert a given fancy human-readable size to bytes. | 60 | * Convert a given fancy human-readable size to bytes. |
61 | * | 61 | * |
62 | * @param fancy_size human readable string (i.e. 1 MB) | 62 | * @param fancy_size human readable string (e.g. 1 MB) |
63 | * @param size set to the size in bytes | 63 | * @param size set to the size in bytes |
64 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error | 64 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
65 | */ | 65 | */ |
@@ -72,7 +72,7 @@ GNUNET_STRINGS_fancy_size_to_bytes (const char *fancy_size, | |||
72 | * Convert a given fancy human-readable time to our internal | 72 | * Convert a given fancy human-readable time to our internal |
73 | * representation. | 73 | * representation. |
74 | * | 74 | * |
75 | * @param fancy_time human readable string (i.e. 1 minute) | 75 | * @param fancy_time human readable string (e.g. 1 minute) |
76 | * @param rtime set to the relative time | 76 | * @param rtime set to the relative time |
77 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error | 77 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
78 | */ | 78 | */ |
@@ -87,7 +87,7 @@ GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_time, | |||
87 | * representation. The human-readable time is expected to be | 87 | * representation. The human-readable time is expected to be |
88 | * in local time, whereas the returned value will be in UTC. | 88 | * in local time, whereas the returned value will be in UTC. |
89 | * | 89 | * |
90 | * @param fancy_time human readable string (i.e. %Y-%m-%d %H:%M:%S) | 90 | * @param fancy_time human readable string (e.g. %Y-%m-%d %H:%M:%S) |
91 | * @param atime set to the absolute time | 91 | * @param atime set to the absolute time |
92 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error | 92 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
93 | */ | 93 | */ |
@@ -548,7 +548,7 @@ GNUNET_STRINGS_to_address_ipv4 (const char *zt_addr, | |||
548 | * `struct sockaddr`. | 548 | * `struct sockaddr`. |
549 | * | 549 | * |
550 | * @param addr the address | 550 | * @param addr the address |
551 | * @param[out] af set to the parsed address family (i.e. AF_INET) | 551 | * @param[out] af set to the parsed address family (e.g. AF_INET) |
552 | * @param[out] sa set to the parsed address | 552 | * @param[out] sa set to the parsed address |
553 | * @return 0 on error, otherwise number of bytes in @a sa | 553 | * @return 0 on error, otherwise number of bytes in @a sa |
554 | */ | 554 | */ |
diff --git a/src/include/gnunet_testbed_service.h b/src/include/gnunet_testbed_service.h index acdfb2034..acb444de4 100644 --- a/src/include/gnunet_testbed_service.h +++ b/src/include/gnunet_testbed_service.h | |||
@@ -485,7 +485,7 @@ GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc); | |||
485 | * @param event_mask bit mask with set of events to call 'cc' for; | 485 | * @param event_mask bit mask with set of events to call 'cc' for; |
486 | * or-ed values of "1LL" shifted by the | 486 | * or-ed values of "1LL" shifted by the |
487 | * respective 'enum GNUNET_TESTBED_EventType' | 487 | * respective 'enum GNUNET_TESTBED_EventType' |
488 | * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...") | 488 | * (e.g. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...") |
489 | * @param cc controller callback to invoke on events | 489 | * @param cc controller callback to invoke on events |
490 | * @param cc_cls closure for cc | 490 | * @param cc_cls closure for cc |
491 | * @return handle to the controller | 491 | * @return handle to the controller |
@@ -1415,7 +1415,7 @@ typedef void | |||
1415 | * @param event_mask bit mask with set of events to call 'cc' for; | 1415 | * @param event_mask bit mask with set of events to call 'cc' for; |
1416 | * or-ed values of "1LL" shifted by the | 1416 | * or-ed values of "1LL" shifted by the |
1417 | * respective 'enum GNUNET_TESTBED_EventType' | 1417 | * respective 'enum GNUNET_TESTBED_EventType' |
1418 | * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") | 1418 | * (e.g. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") |
1419 | * @param cc controller callback to invoke on events; This callback is called | 1419 | * @param cc controller callback to invoke on events; This callback is called |
1420 | * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't | 1420 | * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't |
1421 | * set in the event_mask as this is the only way get access to the | 1421 | * set in the event_mask as this is the only way get access to the |
@@ -1463,7 +1463,7 @@ GNUNET_TESTBED_run (const char *host_filename, | |||
1463 | * @param event_mask bit mask with set of events to call 'cc' for; | 1463 | * @param event_mask bit mask with set of events to call 'cc' for; |
1464 | * or-ed values of "1LL" shifted by the | 1464 | * or-ed values of "1LL" shifted by the |
1465 | * respective 'enum GNUNET_TESTBED_EventType' | 1465 | * respective 'enum GNUNET_TESTBED_EventType' |
1466 | * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") | 1466 | * (e.g. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") |
1467 | * @param cc controller callback to invoke on events; This callback is called | 1467 | * @param cc controller callback to invoke on events; This callback is called |
1468 | * for all peer start events even if #GNUNET_TESTBED_ET_PEER_START isn't | 1468 | * for all peer start events even if #GNUNET_TESTBED_ET_PEER_START isn't |
1469 | * set in the event_mask as this is the only way get access to the | 1469 | * set in the event_mask as this is the only way get access to the |
diff --git a/src/include/gnunet_time_lib.h b/src/include/gnunet_time_lib.h index 38c372f23..b9e87fcbe 100644 --- a/src/include/gnunet_time_lib.h +++ b/src/include/gnunet_time_lib.h | |||
@@ -558,7 +558,7 @@ GNUNET_TIME_get_offset (void); | |||
558 | 558 | ||
559 | 559 | ||
560 | /** | 560 | /** |
561 | * Return the current year (i.e. '2011'). | 561 | * Return the current year (e.g. '2011'). |
562 | */ | 562 | */ |
563 | unsigned int | 563 | unsigned int |
564 | GNUNET_TIME_get_current_year (void); | 564 | GNUNET_TIME_get_current_year (void); |
diff --git a/src/include/gnunet_transport_communication_service.h b/src/include/gnunet_transport_communication_service.h index af2e36b4d..81a382fb2 100644 --- a/src/include/gnunet_transport_communication_service.h +++ b/src/include/gnunet_transport_communication_service.h | |||
@@ -94,17 +94,17 @@ struct GNUNET_TRANSPORT_CommunicatorHandle; | |||
94 | enum GNUNET_TRANSPORT_CommunicatorCharacteristics | 94 | enum GNUNET_TRANSPORT_CommunicatorCharacteristics |
95 | { | 95 | { |
96 | /** | 96 | /** |
97 | * Characteristics are unknown (i.e. DV). | 97 | * Characteristics are unknown (e.g. DV). |
98 | */ | 98 | */ |
99 | GNUNET_TRANSPORT_CC_UNKNOWN = 0, | 99 | GNUNET_TRANSPORT_CC_UNKNOWN = 0, |
100 | 100 | ||
101 | /** | 101 | /** |
102 | * Transmission is reliabile (with ACKs), i.e. TCP/HTTP/HTTPS. | 102 | * Transmission is reliabile (with ACKs), e.g. TCP/HTTP/HTTPS. |
103 | */ | 103 | */ |
104 | GNUNET_TRANSPORT_CC_RELIABLE = 1, | 104 | GNUNET_TRANSPORT_CC_RELIABLE = 1, |
105 | 105 | ||
106 | /** | 106 | /** |
107 | * Transmission is unreliable (i.e. UDP) | 107 | * Transmission is unreliable (e.g. UDP) |
108 | */ | 108 | */ |
109 | GNUNET_TRANSPORT_CC_UNRELIABLE = 2 | 109 | GNUNET_TRANSPORT_CC_UNRELIABLE = 2 |
110 | }; | 110 | }; |
diff --git a/src/include/gnunet_transport_plugin.h b/src/include/gnunet_transport_plugin.h index 01b10f75c..3e6d1edc6 100644 --- a/src/include/gnunet_transport_plugin.h +++ b/src/include/gnunet_transport_plugin.h | |||
@@ -49,7 +49,7 @@ | |||
49 | * connections to a given peer. Typically used by stateful plugins to | 49 | * connections to a given peer. Typically used by stateful plugins to |
50 | * allow the service to refer to specific streams instead of a more | 50 | * allow the service to refer to specific streams instead of a more |
51 | * general notion of "some connection" to the given peer. This is | 51 | * general notion of "some connection" to the given peer. This is |
52 | * useful since sometimes (i.e. for inbound TCP connections) a | 52 | * useful since sometimes (e.g. for inbound TCP connections) a |
53 | * connection may not have an address that can be used for meaningful | 53 | * connection may not have an address that can be used for meaningful |
54 | * distinction between sessions to the same peer. | 54 | * distinction between sessions to the same peer. |
55 | * | 55 | * |
diff --git a/src/include/gnunet_tun_lib.h b/src/include/gnunet_tun_lib.h index 0af9a1d3e..61880cea1 100644 --- a/src/include/gnunet_tun_lib.h +++ b/src/include/gnunet_tun_lib.h | |||
@@ -746,7 +746,7 @@ GNUNET_NETWORK_STRUCT_END | |||
746 | * Initialize an IPv4 header. | 746 | * Initialize an IPv4 header. |
747 | * | 747 | * |
748 | * @param ip header to initialize | 748 | * @param ip header to initialize |
749 | * @param protocol protocol to use (i.e. IPPROTO_UDP) | 749 | * @param protocol protocol to use (e.g. IPPROTO_UDP) |
750 | * @param payload_length number of bytes of payload that follow (excluding IPv4 | 750 | * @param payload_length number of bytes of payload that follow (excluding IPv4 |
751 | * header) | 751 | * header) |
752 | * @param src source IP address to use | 752 | * @param src source IP address to use |
@@ -764,7 +764,7 @@ GNUNET_TUN_initialize_ipv4_header (struct GNUNET_TUN_IPv4Header *ip, | |||
764 | * Initialize an IPv6 header. | 764 | * Initialize an IPv6 header. |
765 | * | 765 | * |
766 | * @param ip header to initialize | 766 | * @param ip header to initialize |
767 | * @param protocol protocol to use (i.e. IPPROTO_UDP) | 767 | * @param protocol protocol to use (e.g. IPPROTO_UDP) |
768 | * @param payload_length number of bytes of payload that follow (excluding IPv4 | 768 | * @param payload_length number of bytes of payload that follow (excluding IPv4 |
769 | * header) | 769 | * header) |
770 | * @param src source IP address to use | 770 | * @param src source IP address to use |
diff --git a/src/namestore/gnunet-namestore-fcfsd.c b/src/namestore/gnunet-namestore-fcfsd.c index 22d108067..6d794746e 100644 --- a/src/namestore/gnunet-namestore-fcfsd.c +++ b/src/namestore/gnunet-namestore-fcfsd.c | |||
@@ -751,7 +751,7 @@ lookup_it_finished (void *cls) | |||
751 | * @param connection MHD connection handle | 751 | * @param connection MHD connection handle |
752 | * @param url the requested url | 752 | * @param url the requested url |
753 | * @param method the HTTP method used ("GET", "PUT", etc.) | 753 | * @param method the HTTP method used ("GET", "PUT", etc.) |
754 | * @param version the HTTP version string (i.e. "HTTP/1.1") | 754 | * @param version the HTTP version string ("HTTP/1.1" for version 1.1, etc.) |
755 | * @param upload_data the data being uploaded (excluding HEADERS, | 755 | * @param upload_data the data being uploaded (excluding HEADERS, |
756 | * for a POST that fits into memory and that is encoded | 756 | * for a POST that fits into memory and that is encoded |
757 | * with a supported encoding, the POST data will NOT be | 757 | * with a supported encoding, the POST data will NOT be |
@@ -1057,13 +1057,12 @@ do_shutdown (void *cls) | |||
1057 | /** | 1057 | /** |
1058 | * Method called to inform about the egos of this peer. | 1058 | * Method called to inform about the egos of this peer. |
1059 | * | 1059 | * |
1060 | * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, | 1060 | * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, this |
1061 | * this function is only called ONCE, and 'NULL' being passed in | 1061 | * function is only called ONCE, and 'NULL' being passed in @a ego does |
1062 | * @a ego does indicate an error (i.e. name is taken or no default | 1062 | * indicate an error (for example because name is taken or no default value is |
1063 | * value is known). If @a ego is non-NULL and if '*ctx' | 1063 | * known). If @a ego is non-NULL and if '*ctx' is set in those callbacks, the |
1064 | * is set in those callbacks, the value WILL be passed to a subsequent | 1064 | * value WILL be passed to a subsequent call to the identity callback of |
1065 | * call to the identity callback of #GNUNET_IDENTITY_connect (if | 1065 | * #GNUNET_IDENTITY_connect (if that one was not NULL). |
1066 | * that one was not NULL). | ||
1067 | * | 1066 | * |
1068 | * @param cls closure, NULL | 1067 | * @param cls closure, NULL |
1069 | * @param ego ego handle | 1068 | * @param ego ego handle |
diff --git a/src/namestore/gnunet-zoneimport.c b/src/namestore/gnunet-zoneimport.c index ce62b52d5..68b43a016 100644 --- a/src/namestore/gnunet-zoneimport.c +++ b/src/namestore/gnunet-zoneimport.c | |||
@@ -1713,13 +1713,12 @@ process_stdin (void *cls) | |||
1713 | * with 'NULL' for @a ego. That does NOT mean that the callback won't | 1713 | * with 'NULL' for @a ego. That does NOT mean that the callback won't |
1714 | * be invoked in the future or that there was an error. | 1714 | * be invoked in the future or that there was an error. |
1715 | * | 1715 | * |
1716 | * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, | 1716 | * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, this |
1717 | * this function is only called ONCE, and 'NULL' being passed in | 1717 | * function is only called ONCE, and 'NULL' being passed in @a ego does |
1718 | * @a ego does indicate an error (i.e. name is taken or no default | 1718 | * indicate an error (for example because name is taken or no default value is |
1719 | * value is known). If @a ego is non-NULL and if '*ctx' | 1719 | * known). If @a ego is non-NULL and if '*ctx' is set in those callbacks, the |
1720 | * is set in those callbacks, the value WILL be passed to a subsequent | 1720 | * value WILL be passed to a subsequent call to the identity callback of |
1721 | * call to the identity callback of #GNUNET_IDENTITY_connect (if | 1721 | * #GNUNET_IDENTITY_connect (if that one was not NULL). |
1722 | * that one was not NULL). | ||
1723 | * | 1722 | * |
1724 | * When an identity is renamed, this function is called with the | 1723 | * When an identity is renamed, this function is called with the |
1725 | * (known) @a ego but the NEW @a name. | 1724 | * (known) @a ego but the NEW @a name. |
diff --git a/src/peerinfo-tool/gnunet-peerinfo_plugins.c b/src/peerinfo-tool/gnunet-peerinfo_plugins.c index 901ded014..e196ec58a 100644 --- a/src/peerinfo-tool/gnunet-peerinfo_plugins.c +++ b/src/peerinfo-tool/gnunet-peerinfo_plugins.c | |||
@@ -50,12 +50,12 @@ struct TransportPlugin | |||
50 | struct GNUNET_TRANSPORT_PluginFunctions *api; | 50 | struct GNUNET_TRANSPORT_PluginFunctions *api; |
51 | 51 | ||
52 | /** | 52 | /** |
53 | * Short name for the plugin (i.e. "tcp"). | 53 | * Short name for the plugin (e.g. "tcp"). |
54 | */ | 54 | */ |
55 | char *short_name; | 55 | char *short_name; |
56 | 56 | ||
57 | /** | 57 | /** |
58 | * Name of the library (i.e. "gnunet_plugin_transport_tcp"). | 58 | * Name of the library (e.g. "gnunet_plugin_transport_tcp"). |
59 | */ | 59 | */ |
60 | char *lib_name; | 60 | char *lib_name; |
61 | 61 | ||
diff --git a/src/pt/test_gns_vpn.c b/src/pt/test_gns_vpn.c index 7b4abaec2..e20d835f8 100644 --- a/src/pt/test_gns_vpn.c +++ b/src/pt/test_gns_vpn.c | |||
@@ -530,13 +530,12 @@ fork_and_exec (const char *file, | |||
530 | * with 'NULL' for @a ego. That does NOT mean that the callback won't | 530 | * with 'NULL' for @a ego. That does NOT mean that the callback won't |
531 | * be invoked in the future or that there was an error. | 531 | * be invoked in the future or that there was an error. |
532 | * | 532 | * |
533 | * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, | 533 | * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, this |
534 | * this function is only called ONCE, and 'NULL' being passed in | 534 | * function is only called ONCE, and 'NULL' being passed in @a ego does |
535 | * @a ego does indicate an error (i.e. name is taken or no default | 535 | * indicate an error (for example because name is taken or no default value is |
536 | * value is known). If @a ego is non-NULL and if '*ctx' | 536 | * known). If @a ego is non-NULL and if '*ctx' is set in those callbacks, the |
537 | * is set in those callbacks, the value WILL be passed to a subsequent | 537 | * value WILL be passed to a subsequent call to the identity callback of |
538 | * call to the identity callback of #GNUNET_IDENTITY_connect (if | 538 | * #GNUNET_IDENTITY_connect (if that one was not NULL). |
539 | * that one was not NULL). | ||
540 | * | 539 | * |
541 | * When an identity is renamed, this function is called with the | 540 | * When an identity is renamed, this function is called with the |
542 | * (known) @a ego but the NEW @a name. | 541 | * (known) @a ego but the NEW @a name. |
diff --git a/src/reclaim/plugin_gnsrecord_reclaim.c b/src/reclaim/plugin_gnsrecord_reclaim.c index 9e4f0a5c4..ce6fe483d 100644 --- a/src/reclaim/plugin_gnsrecord_reclaim.c +++ b/src/reclaim/plugin_gnsrecord_reclaim.c | |||
@@ -118,7 +118,7 @@ static struct | |||
118 | 118 | ||
119 | 119 | ||
120 | /** | 120 | /** |
121 | * Convert a type name (i.e. "AAAA") to the corresponding number. | 121 | * Convert a type name (e.g. "AAAA") to the corresponding number. |
122 | * | 122 | * |
123 | * @param cls closure, unused | 123 | * @param cls closure, unused |
124 | * @param dns_typename name to convert | 124 | * @param dns_typename name to convert |
@@ -138,7 +138,7 @@ typename_to_number (void *cls, const char *dns_typename) | |||
138 | 138 | ||
139 | 139 | ||
140 | /** | 140 | /** |
141 | * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") | 141 | * Convert a type number to the corresponding type string (e.g. 1 to "A") |
142 | * | 142 | * |
143 | * @param cls closure, unused | 143 | * @param cls closure, unused |
144 | * @param type number of a type to convert | 144 | * @param type number of a type to convert |
diff --git a/src/reclaim/plugin_reclaim_attribute_basic.c b/src/reclaim/plugin_reclaim_attribute_basic.c index c87922886..66f59998a 100644 --- a/src/reclaim/plugin_reclaim_attribute_basic.c +++ b/src/reclaim/plugin_reclaim_attribute_basic.c | |||
@@ -124,7 +124,7 @@ basic_typename_to_number (void *cls, const char *basic_typename) | |||
124 | 124 | ||
125 | 125 | ||
126 | /** | 126 | /** |
127 | * Convert a type number (i.e. 1) to the corresponding type string | 127 | * Convert a type number to the corresponding type string (e.g. 1 to "A") |
128 | * | 128 | * |
129 | * @param cls closure, unused | 129 | * @param cls closure, unused |
130 | * @param type number of a type to convert | 130 | * @param type number of a type to convert |
diff --git a/src/reclaim/plugin_reclaim_credential_jwt.c b/src/reclaim/plugin_reclaim_credential_jwt.c index e5dc90363..fb01903aa 100644 --- a/src/reclaim/plugin_reclaim_credential_jwt.c +++ b/src/reclaim/plugin_reclaim_credential_jwt.c | |||
@@ -122,7 +122,7 @@ jwt_typename_to_number (void *cls, const char *jwt_typename) | |||
122 | 122 | ||
123 | 123 | ||
124 | /** | 124 | /** |
125 | * Convert a type number (i.e. 1) to the corresponding type string | 125 | * Convert a type number to the corresponding type string (e.g. 1 to "A") |
126 | * | 126 | * |
127 | * @param cls closure, unused | 127 | * @param cls closure, unused |
128 | * @param type number of a type to convert | 128 | * @param type number of a type to convert |
diff --git a/src/reclaim/plugin_rest_openid_connect.c b/src/reclaim/plugin_rest_openid_connect.c index c6259d745..fef79fb10 100644 --- a/src/reclaim/plugin_rest_openid_connect.c +++ b/src/reclaim/plugin_rest_openid_connect.c | |||
@@ -2478,13 +2478,12 @@ userinfo_endpoint (struct GNUNET_REST_RequestHandle *con_handle, | |||
2478 | * with 'NULL' for 'ego'. That does NOT mean that the callback won't | 2478 | * with 'NULL' for 'ego'. That does NOT mean that the callback won't |
2479 | * be invoked in the future or that there was an error. | 2479 | * be invoked in the future or that there was an error. |
2480 | * | 2480 | * |
2481 | * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', | 2481 | * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', this |
2482 | * this function is only called ONCE, and 'NULL' being passed in | 2482 | * function is only called ONCE, and 'NULL' being passed in 'ego' does |
2483 | * 'ego' does indicate an error (i.e. name is taken or no default | 2483 | * indicate an error (for example because name is taken or no default value is |
2484 | * value is known). If 'ego' is non-NULL and if '*ctx' | 2484 | * known). If 'ego' is non-NULL and if '*ctx' is set in those callbacks, the |
2485 | * is set in those callbacks, the value WILL be passed to a subsequent | 2485 | * value WILL be passed to a subsequent call to the identity callback of |
2486 | * call to the identity callback of 'GNUNET_IDENTITY_connect' (if | 2486 | * 'GNUNET_IDENTITY_connect' (if that one was not NULL). |
2487 | * that one was not NULL). | ||
2488 | * | 2487 | * |
2489 | * When an identity is renamed, this function is called with the | 2488 | * When an identity is renamed, this function is called with the |
2490 | * (known) ego but the NEW identifier. | 2489 | * (known) ego but the NEW identifier. |
diff --git a/src/reclaim/plugin_rest_reclaim.c b/src/reclaim/plugin_rest_reclaim.c index 39d24ea61..1d1231cbd 100644 --- a/src/reclaim/plugin_rest_reclaim.c +++ b/src/reclaim/plugin_rest_reclaim.c | |||
@@ -1332,13 +1332,12 @@ options_cont (struct GNUNET_REST_RequestHandle *con_handle, | |||
1332 | * with 'NULL' for 'ego'. That does NOT mean that the callback won't | 1332 | * with 'NULL' for 'ego'. That does NOT mean that the callback won't |
1333 | * be invoked in the future or that there was an error. | 1333 | * be invoked in the future or that there was an error. |
1334 | * | 1334 | * |
1335 | * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', | 1335 | * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', this |
1336 | * this function is only called ONCE, and 'NULL' being passed in | 1336 | * function is only called ONCE, and 'NULL' being passed in 'ego' does |
1337 | * 'ego' does indicate an error (i.e. name is taken or no default | 1337 | * indicate an error (for example because name is taken or no default value is |
1338 | * value is known). If 'ego' is non-NULL and if '*ctx' | 1338 | * known). If 'ego' is non-NULL and if '*ctx' is set in those callbacks, the |
1339 | * is set in those callbacks, the value WILL be passed to a subsequent | 1339 | * value WILL be passed to a subsequent call to the identity callback of |
1340 | * call to the identity callback of 'GNUNET_IDENTITY_connect' (if | 1340 | * 'GNUNET_IDENTITY_connect' (if that one was not NULL). |
1341 | * that one was not NULL). | ||
1342 | * | 1341 | * |
1343 | * When an identity is renamed, this function is called with the | 1342 | * When an identity is renamed, this function is called with the |
1344 | * (known) ego but the NEW identifier. | 1343 | * (known) ego but the NEW identifier. |
diff --git a/src/rest/gnunet-rest-server.c b/src/rest/gnunet-rest-server.c index ecb3e2ae5..63847587b 100644 --- a/src/rest/gnunet-rest-server.c +++ b/src/rest/gnunet-rest-server.c | |||
@@ -436,7 +436,7 @@ post_data_iter (void *cls, | |||
436 | * @param con MHD connection handle | 436 | * @param con MHD connection handle |
437 | * @param url the url in the request | 437 | * @param url the url in the request |
438 | * @param meth the HTTP method used ("GET", "PUT", etc.) | 438 | * @param meth the HTTP method used ("GET", "PUT", etc.) |
439 | * @param ver the HTTP version string (i.e. "HTTP/1.1") | 439 | * @param ver the HTTP version string ("HTTP/1.1" for version 1.1, etc.) |
440 | * @param upload_data the data being uploaded (excluding HEADERS, | 440 | * @param upload_data the data being uploaded (excluding HEADERS, |
441 | * for a POST that fits into memory and that is encoded | 441 | * for a POST that fits into memory and that is encoded |
442 | * with a supported encoding, the POST data will NOT be | 442 | * with a supported encoding, the POST data will NOT be |
diff --git a/src/testbed/testbed_api.c b/src/testbed/testbed_api.c index f291892c6..386850b89 100644 --- a/src/testbed/testbed_api.c +++ b/src/testbed/testbed_api.c | |||
@@ -1546,7 +1546,7 @@ mq_error_handler (void *cls, enum GNUNET_MQ_Error error) | |||
1546 | * @param event_mask bit mask with set of events to call 'cc' for; | 1546 | * @param event_mask bit mask with set of events to call 'cc' for; |
1547 | * or-ed values of "1LL" shifted by the | 1547 | * or-ed values of "1LL" shifted by the |
1548 | * respective 'enum GNUNET_TESTBED_EventType' | 1548 | * respective 'enum GNUNET_TESTBED_EventType' |
1549 | * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...") | 1549 | * (e.g. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...") |
1550 | * @param cc controller callback to invoke on events | 1550 | * @param cc controller callback to invoke on events |
1551 | * @param cc_cls closure for cc | 1551 | * @param cc_cls closure for cc |
1552 | * @return handle to the controller | 1552 | * @return handle to the controller |
diff --git a/src/testbed/testbed_api_test.c b/src/testbed/testbed_api_test.c index 30dbe455d..dd43cf2f6 100644 --- a/src/testbed/testbed_api_test.c +++ b/src/testbed/testbed_api_test.c | |||
@@ -109,7 +109,7 @@ run (void *cls, char *const *args, const char *cfgfile, | |||
109 | * @param event_mask bit mask with set of events to call 'cc' for; | 109 | * @param event_mask bit mask with set of events to call 'cc' for; |
110 | * or-ed values of "1LL" shifted by the | 110 | * or-ed values of "1LL" shifted by the |
111 | * respective 'enum GNUNET_TESTBED_EventType' | 111 | * respective 'enum GNUNET_TESTBED_EventType' |
112 | * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") | 112 | * (e.g. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") |
113 | * @param cc controller callback to invoke on events; This callback is called | 113 | * @param cc controller callback to invoke on events; This callback is called |
114 | * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't | 114 | * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't |
115 | * set in the event_mask as this is the only way get access to the | 115 | * set in the event_mask as this is the only way get access to the |
diff --git a/src/testbed/testbed_api_testbed.c b/src/testbed/testbed_api_testbed.c index 7ae30e0c6..1aa344e99 100644 --- a/src/testbed/testbed_api_testbed.c +++ b/src/testbed/testbed_api_testbed.c | |||
@@ -1237,7 +1237,7 @@ timeout_task (void *cls) | |||
1237 | * @param event_mask bit mask with set of events to call 'cc' for; | 1237 | * @param event_mask bit mask with set of events to call 'cc' for; |
1238 | * or-ed values of "1LL" shifted by the | 1238 | * or-ed values of "1LL" shifted by the |
1239 | * respective 'enum GNUNET_TESTBED_EventType' | 1239 | * respective 'enum GNUNET_TESTBED_EventType' |
1240 | * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") | 1240 | * (e.g. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") |
1241 | * @param cc controller callback to invoke on events; This callback is called | 1241 | * @param cc controller callback to invoke on events; This callback is called |
1242 | * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't | 1242 | * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't |
1243 | * set in the event_mask as this is the only way get access to the | 1243 | * set in the event_mask as this is the only way get access to the |
diff --git a/src/testing/testing.c b/src/testing/testing.c index 9724fb55b..991c11a6c 100644 --- a/src/testing/testing.c +++ b/src/testing/testing.c | |||
@@ -91,7 +91,7 @@ struct SharedService | |||
91 | struct GNUNET_TESTING_System | 91 | struct GNUNET_TESTING_System |
92 | { | 92 | { |
93 | /** | 93 | /** |
94 | * Prefix (i.e. "/tmp/gnunet-testing/") we prepend to each | 94 | * Prefix (e.g. "/tmp/gnunet-testing/") we prepend to each |
95 | * GNUNET_HOME. | 95 | * GNUNET_HOME. |
96 | */ | 96 | */ |
97 | char *tmppath; | 97 | char *tmppath; |
diff --git a/src/transport/gnunet-helper-transport-bluetooth.c b/src/transport/gnunet-helper-transport-bluetooth.c index 4923e6428..ef3a6292b 100644 --- a/src/transport/gnunet-helper-transport-bluetooth.c +++ b/src/transport/gnunet-helper-transport-bluetooth.c | |||
@@ -1374,7 +1374,7 @@ inquiry_devices: // skip the conditions and force a inquiry for new devices | |||
1374 | * stdin/stdout of this process. Error messages are written to stderr. | 1374 | * stdin/stdout of this process. Error messages are written to stderr. |
1375 | * | 1375 | * |
1376 | * @param argc number of arguments, must be 2 | 1376 | * @param argc number of arguments, must be 2 |
1377 | * @param argv arguments only argument is the name of the interface (i.e. 'hci0') | 1377 | * @param argv arguments only argument is the name of the interface (e.g. 'hci0') |
1378 | * @return 0 on success (never happens, as we don't return unless aborted), 1 on error | 1378 | * @return 0 on success (never happens, as we don't return unless aborted), 1 on error |
1379 | * | 1379 | * |
1380 | **** similar to gnunet-helper-transport-wlan.c **** | 1380 | **** similar to gnunet-helper-transport-wlan.c **** |
diff --git a/src/transport/gnunet-helper-transport-wlan.c b/src/transport/gnunet-helper-transport-wlan.c index f1b190993..d90565c9c 100644 --- a/src/transport/gnunet-helper-transport-wlan.c +++ b/src/transport/gnunet-helper-transport-wlan.c | |||
@@ -1935,7 +1935,7 @@ stdin_send_hw (void *cls, const struct GNUNET_MessageHeader *hdr) | |||
1935 | * process. Error messages are written to stdout. | 1935 | * process. Error messages are written to stdout. |
1936 | * | 1936 | * |
1937 | * @param argc number of arguments, must be 2 | 1937 | * @param argc number of arguments, must be 2 |
1938 | * @param argv arguments only argument is the name of the interface (i.e. 'mon0') | 1938 | * @param argv arguments only argument is the name of the interface (e.g. 'mon0') |
1939 | * @return 0 on success (never happens, as we don't return unless aborted), 1 on error | 1939 | * @return 0 on success (never happens, as we don't return unless aborted), 1 on error |
1940 | */ | 1940 | */ |
1941 | int | 1941 | int |
diff --git a/src/transport/gnunet-service-transport_plugins.c b/src/transport/gnunet-service-transport_plugins.c index d0a10cbc7..c88532806 100644 --- a/src/transport/gnunet-service-transport_plugins.c +++ b/src/transport/gnunet-service-transport_plugins.c | |||
@@ -51,12 +51,12 @@ struct TransportPlugin | |||
51 | struct GNUNET_TRANSPORT_PluginFunctions *api; | 51 | struct GNUNET_TRANSPORT_PluginFunctions *api; |
52 | 52 | ||
53 | /** | 53 | /** |
54 | * Short name for the plugin (i.e. "tcp"). | 54 | * Short name for the plugin (e.g. "tcp"). |
55 | */ | 55 | */ |
56 | char *short_name; | 56 | char *short_name; |
57 | 57 | ||
58 | /** | 58 | /** |
59 | * Name of the library (i.e. "gnunet_plugin_transport_tcp"). | 59 | * Name of the library (e.g. "gnunet_plugin_transport_tcp"). |
60 | */ | 60 | */ |
61 | char *lib_name; | 61 | char *lib_name; |
62 | 62 | ||
diff --git a/src/util/client.c b/src/util/client.c index 746c0eb55..afd2fe900 100644 --- a/src/util/client.c +++ b/src/util/client.c | |||
@@ -892,7 +892,7 @@ connection_client_cancel_impl (struct GNUNET_MQ_Handle *mq, | |||
892 | * #GNUNET_NO if the service is (definitively) down, | 892 | * #GNUNET_NO if the service is (definitively) down, |
893 | * #GNUNET_SYSERR if the configuration does not give us | 893 | * #GNUNET_SYSERR if the configuration does not give us |
894 | * the necessary information about the service, or if | 894 | * the necessary information about the service, or if |
895 | * we could not check (i.e. socket() failed) | 895 | * we could not check (e.g. socket() failed) |
896 | */ | 896 | */ |
897 | int | 897 | int |
898 | GNUNET_CLIENT_test (const struct GNUNET_CONFIGURATION_Handle *cfg, | 898 | GNUNET_CLIENT_test (const struct GNUNET_CONFIGURATION_Handle *cfg, |
diff --git a/src/util/container_meta_data.c b/src/util/container_meta_data.c index efaac1136..2c477db40 100644 --- a/src/util/container_meta_data.c +++ b/src/util/container_meta_data.c | |||
@@ -337,7 +337,7 @@ GNUNET_CONTAINER_meta_data_test_equal (const struct GNUNET_CONTAINER_MetaData | |||
337 | * | 337 | * |
338 | * @param md metadata to extend | 338 | * @param md metadata to extend |
339 | * @param plugin_name name of the plugin that produced this value; | 339 | * @param plugin_name name of the plugin that produced this value; |
340 | * special values can be used (i.e. '<zlib>' for zlib being | 340 | * special values can be used (e.g. '<zlib>' for zlib being |
341 | * used in the main libextractor library and yielding | 341 | * used in the main libextractor library and yielding |
342 | * meta data). | 342 | * meta data). |
343 | * @param type libextractor-type describing the meta data | 343 | * @param type libextractor-type describing the meta data |
@@ -427,7 +427,7 @@ GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md, | |||
427 | * | 427 | * |
428 | * @param cls the `struct GNUNET_CONTAINER_MetaData` to merge into | 428 | * @param cls the `struct GNUNET_CONTAINER_MetaData` to merge into |
429 | * @param plugin_name name of the plugin that produced this value; | 429 | * @param plugin_name name of the plugin that produced this value; |
430 | * special values can be used (i.e. '<zlib>' for zlib being | 430 | * special values can be used (e.g. '<zlib>' for zlib being |
431 | * used in the main libextractor library and yielding | 431 | * used in the main libextractor library and yielding |
432 | * meta data). | 432 | * meta data). |
433 | * @param type libextractor-type describing the meta data | 433 | * @param type libextractor-type describing the meta data |
diff --git a/src/util/crypto_rsa.c b/src/util/crypto_rsa.c index 5e4c4d1e6..4d3de00bc 100644 --- a/src/util/crypto_rsa.c +++ b/src/util/crypto_rsa.c | |||
@@ -473,7 +473,7 @@ rsa_gcd_validate (gcry_mpi_t r, gcry_mpi_t n) | |||
473 | /** | 473 | /** |
474 | * Create a blinding key | 474 | * Create a blinding key |
475 | * | 475 | * |
476 | * @param len length of the key in bits (i.e. 2048) | 476 | * @param len length of the key in bits (e.g. 2048) |
477 | * @param bks pre-secret to use to derive the blinding key | 477 | * @param bks pre-secret to use to derive the blinding key |
478 | * @return the newly created blinding key, NULL if RSA key is malicious | 478 | * @return the newly created blinding key, NULL if RSA key is malicious |
479 | */ | 479 | */ |
diff --git a/src/util/network.c b/src/util/network.c index c4adefb8f..e771a9834 100644 --- a/src/util/network.c +++ b/src/util/network.c | |||
@@ -1269,7 +1269,7 @@ GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds) | |||
1269 | /** | 1269 | /** |
1270 | * Test if the given @a port is available. | 1270 | * Test if the given @a port is available. |
1271 | * | 1271 | * |
1272 | * @param ipproto transport protocol to test (i.e. IPPROTO_TCP) | 1272 | * @param ipproto transport protocol to test (e.g. IPPROTO_TCP) |
1273 | * @param port port number to test | 1273 | * @param port port number to test |
1274 | * @return #GNUNET_OK if the port is available, #GNUNET_NO if not | 1274 | * @return #GNUNET_OK if the port is available, #GNUNET_NO if not |
1275 | */ | 1275 | */ |
diff --git a/src/util/scheduler.c b/src/util/scheduler.c index 759312df5..d5c7b964f 100644 --- a/src/util/scheduler.c +++ b/src/util/scheduler.c | |||
@@ -193,7 +193,7 @@ struct GNUNET_SCHEDULER_Task | |||
193 | /** | 193 | /** |
194 | * Why is the task ready? Set after task is added to ready queue. | 194 | * Why is the task ready? Set after task is added to ready queue. |
195 | * Initially set to zero. All reasons that have already been | 195 | * Initially set to zero. All reasons that have already been |
196 | * satisfied (i.e. read or write ready) will be set over time. | 196 | * satisfied (e.g. read or write ready) will be set over time. |
197 | */ | 197 | */ |
198 | enum GNUNET_SCHEDULER_Reason reason; | 198 | enum GNUNET_SCHEDULER_Reason reason; |
199 | 199 | ||
diff --git a/src/util/strings.c b/src/util/strings.c index 61e04c457..b62d5f547 100644 --- a/src/util/strings.c +++ b/src/util/strings.c | |||
@@ -316,7 +316,7 @@ convert_with_table (const char *input, | |||
316 | /** | 316 | /** |
317 | * Convert a given fancy human-readable size to bytes. | 317 | * Convert a given fancy human-readable size to bytes. |
318 | * | 318 | * |
319 | * @param fancy_size human readable string (i.e. 1 MB) | 319 | * @param fancy_size human readable string (e.g. 1 MB) |
320 | * @param size set to the size in bytes | 320 | * @param size set to the size in bytes |
321 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error | 321 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
322 | */ | 322 | */ |
@@ -348,7 +348,7 @@ GNUNET_STRINGS_fancy_size_to_bytes (const char *fancy_size, | |||
348 | * Convert a given fancy human-readable time to our internal | 348 | * Convert a given fancy human-readable time to our internal |
349 | * representation. | 349 | * representation. |
350 | * | 350 | * |
351 | * @param fancy_time human readable string (i.e. 1 minute) | 351 | * @param fancy_time human readable string (e.g. 1 minute) |
352 | * @param rtime set to the relative time | 352 | * @param rtime set to the relative time |
353 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error | 353 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
354 | */ | 354 | */ |
@@ -399,7 +399,7 @@ GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_time, | |||
399 | * representation. The human-readable time is expected to be | 399 | * representation. The human-readable time is expected to be |
400 | * in local time, whereas the returned value will be in UTC. | 400 | * in local time, whereas the returned value will be in UTC. |
401 | * | 401 | * |
402 | * @param fancy_time human readable string (i.e. %Y-%m-%d %H:%M:%S) | 402 | * @param fancy_time human readable string (e.g. %Y-%m-%d %H:%M:%S) |
403 | * @param atime set to the absolute time | 403 | * @param atime set to the absolute time |
404 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error | 404 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
405 | */ | 405 | */ |
@@ -1364,7 +1364,7 @@ GNUNET_STRINGS_to_address_ip (const char *addr, | |||
1364 | * `struct sockaddr`. | 1364 | * `struct sockaddr`. |
1365 | * | 1365 | * |
1366 | * @param addr the address | 1366 | * @param addr the address |
1367 | * @param[out] af set to the parsed address family (i.e. AF_INET) | 1367 | * @param[out] af set to the parsed address family (e.g. AF_INET) |
1368 | * @param[out] sa set to the parsed address | 1368 | * @param[out] sa set to the parsed address |
1369 | * @return 0 on error, otherwise number of bytes in @a sa | 1369 | * @return 0 on error, otherwise number of bytes in @a sa |
1370 | */ | 1370 | */ |
diff --git a/src/util/tun.c b/src/util/tun.c index 0e3017551..d2b675c71 100644 --- a/src/util/tun.c +++ b/src/util/tun.c | |||
@@ -37,7 +37,7 @@ | |||
37 | * Initialize an IPv4 header. | 37 | * Initialize an IPv4 header. |
38 | * | 38 | * |
39 | * @param ip header to initialize | 39 | * @param ip header to initialize |
40 | * @param protocol protocol to use (i.e. IPPROTO_UDP) | 40 | * @param protocol protocol to use (e.g. IPPROTO_UDP) |
41 | * @param payload_length number of bytes of payload that follow (excluding IPv4 header) | 41 | * @param payload_length number of bytes of payload that follow (excluding IPv4 header) |
42 | * @param src source IP address to use | 42 | * @param src source IP address to use |
43 | * @param dst destination IP address to use | 43 | * @param dst destination IP address to use |
@@ -72,7 +72,7 @@ GNUNET_TUN_initialize_ipv4_header (struct GNUNET_TUN_IPv4Header *ip, | |||
72 | * Initialize an IPv6 header. | 72 | * Initialize an IPv6 header. |
73 | * | 73 | * |
74 | * @param ip header to initialize | 74 | * @param ip header to initialize |
75 | * @param protocol protocol to use (i.e. IPPROTO_UDP), technically "next_header" for IPv6 | 75 | * @param protocol protocol to use (e.g. IPPROTO_UDP), technically "next_header" for IPv6 |
76 | * @param payload_length number of bytes of payload that follow (excluding IPv6 header) | 76 | * @param payload_length number of bytes of payload that follow (excluding IPv6 header) |
77 | * @param src source IP address to use | 77 | * @param src source IP address to use |
78 | * @param dst destination IP address to use | 78 | * @param dst destination IP address to use |