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/include | |
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/include')
-rw-r--r-- | src/include/gnunet_ats_service.h | 6 | ||||
-rw-r--r-- | src/include/gnunet_ats_transport_service.h | 2 | ||||
-rw-r--r-- | src/include/gnunet_client_lib.h | 2 | ||||
-rw-r--r-- | src/include/gnunet_container_lib.h | 8 | ||||
-rw-r--r-- | src/include/gnunet_crypto_lib.h | 4 | ||||
-rw-r--r-- | src/include/gnunet_curl_lib.h | 2 | ||||
-rw-r--r-- | src/include/gnunet_dht_service.h | 2 | ||||
-rw-r--r-- | src/include/gnunet_getopt_lib.h | 2 | ||||
-rw-r--r-- | src/include/gnunet_gnsrecord_lib.h | 4 | ||||
-rw-r--r-- | src/include/gnunet_gnsrecord_plugin.h | 6 | ||||
-rw-r--r-- | src/include/gnunet_identity_service.h | 15 | ||||
-rw-r--r-- | src/include/gnunet_mq_lib.h | 8 | ||||
-rw-r--r-- | src/include/gnunet_network_lib.h | 2 | ||||
-rw-r--r-- | src/include/gnunet_reclaim_plugin.h | 12 | ||||
-rw-r--r-- | src/include/gnunet_strings_lib.h | 8 | ||||
-rw-r--r-- | src/include/gnunet_testbed_service.h | 6 | ||||
-rw-r--r-- | src/include/gnunet_time_lib.h | 2 | ||||
-rw-r--r-- | src/include/gnunet_transport_communication_service.h | 6 | ||||
-rw-r--r-- | src/include/gnunet_transport_plugin.h | 2 | ||||
-rw-r--r-- | src/include/gnunet_tun_lib.h | 4 |
20 files changed, 51 insertions, 52 deletions
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 |