diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-08-22 06:28:34 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-08-22 06:28:34 +0000 |
commit | b94abb8ad0d6644e8f1a03706e0a590c0c69dd91 (patch) | |
tree | 9ea7b991f91d7c952a889d227c8ac55931ed0b45 /src | |
parent | 60ecaf195aea1b6a62d12c60e05ade1f2308e76f (diff) | |
download | gnunet-b94abb8ad0d6644e8f1a03706e0a590c0c69dd91.tar.gz gnunet-b94abb8ad0d6644e8f1a03706e0a590c0c69dd91.zip |
-doxygen fixes
Diffstat (limited to 'src')
-rw-r--r-- | src/include/gnunet_core_service.h | 11 | ||||
-rw-r--r-- | src/include/gnunet_statistics_service.h | 11 |
2 files changed, 9 insertions, 13 deletions
diff --git a/src/include/gnunet_core_service.h b/src/include/gnunet_core_service.h index 7fc77d094..19c2acbdf 100644 --- a/src/include/gnunet_core_service.h +++ b/src/include/gnunet_core_service.h | |||
@@ -155,7 +155,7 @@ typedef void (*GNUNET_CORE_StartupCallback) (void *cls, | |||
155 | * messages if the client does not process them fast enough (for this | 155 | * messages if the client does not process them fast enough (for this |
156 | * notification type, a bounded queue is used) | 156 | * notification type, a bounded queue is used) |
157 | * @param inbound_hdr_only set to #GNUNET_YES if @a inbound_notify will only read the | 157 | * @param inbound_hdr_only set to #GNUNET_YES if @a inbound_notify will only read the |
158 | * GNUNET_MessageHeader and hence we do not need to give it the full message; | 158 | * `struct GNUNET_MessageHeader` and hence we do not need to give it the full message; |
159 | * can be used to improve efficiency, ignored if inbound_notify is NULL | 159 | * can be used to improve efficiency, ignored if inbound_notify is NULL |
160 | * note that the core is allowed to drop notifications about inbound | 160 | * note that the core is allowed to drop notifications about inbound |
161 | * messages if the client does not process them fast enough (for this | 161 | * messages if the client does not process them fast enough (for this |
@@ -165,7 +165,7 @@ typedef void (*GNUNET_CORE_StartupCallback) (void *cls, | |||
165 | * messages if the client does not process them fast enough (for this | 165 | * messages if the client does not process them fast enough (for this |
166 | * notification type, a bounded queue is used) | 166 | * notification type, a bounded queue is used) |
167 | * @param outbound_hdr_only set to #GNUNET_YES if @a outbound_notify will only read the | 167 | * @param outbound_hdr_only set to #GNUNET_YES if @a outbound_notify will only read the |
168 | * GNUNET_MessageHeader and hence we do not need to give it the full message | 168 | * `struct GNUNET_MessageHeader` and hence we do not need to give it the full message |
169 | * can be used to improve efficiency, ignored if outbound_notify is NULL | 169 | * can be used to improve efficiency, ignored if outbound_notify is NULL |
170 | * note that the core is allowed to drop notifications about outbound | 170 | * note that the core is allowed to drop notifications about outbound |
171 | * messages if the client does not process them fast enough (for this | 171 | * messages if the client does not process them fast enough (for this |
@@ -280,11 +280,8 @@ GNUNET_CORE_iterate_peers (const struct GNUNET_CONFIGURATION_Handle *cfg, | |||
280 | * cirumstances (GNUNET_TESTBED uses it), normal users of the CORE API are | 280 | * cirumstances (GNUNET_TESTBED uses it), normal users of the CORE API are |
281 | * expected to track which peers are connected based on the connect/disconnect | 281 | * expected to track which peers are connected based on the connect/disconnect |
282 | * callbacks from #GNUNET_CORE_connect. This function is NOT part of the | 282 | * callbacks from #GNUNET_CORE_connect. This function is NOT part of the |
283 | * 'versioned', 'official' API. The difference between this function and the | 283 | * 'versioned', 'official' API. This function returns |
284 | * function #GNUNET_CORE_is_peer_connected is that this one returns | 284 | * synchronously after looking in the CORE API cache. |
285 | * synchronously after looking in the CORE API cache. The function | ||
286 | * #GNUNET_CORE_is_peer_connected sends a message to the CORE service and hence | ||
287 | * its response is given asynchronously. | ||
288 | * | 285 | * |
289 | * @param h the core handle | 286 | * @param h the core handle |
290 | * @param pid the identity of the peer to check if it has been connected to us | 287 | * @param pid the identity of the peer to check if it has been connected to us |
diff --git a/src/include/gnunet_statistics_service.h b/src/include/gnunet_statistics_service.h index c2fb46109..75c7bd18a 100644 --- a/src/include/gnunet_statistics_service.h +++ b/src/include/gnunet_statistics_service.h | |||
@@ -22,7 +22,7 @@ | |||
22 | * @file include/gnunet_statistics_service.h | 22 | * @file include/gnunet_statistics_service.h |
23 | * @brief API to create, modify and access statistics about | 23 | * @brief API to create, modify and access statistics about |
24 | * the operation of GNUnet; all statistical values | 24 | * the operation of GNUnet; all statistical values |
25 | * must be of type "unsigned long long". | 25 | * must be of type `unsigned long long`. |
26 | * @author Christian Grothoff | 26 | * @author Christian Grothoff |
27 | * @defgroup statistics track statistics or provide access to statistics | 27 | * @defgroup statistics track statistics or provide access to statistics |
28 | * @{ | 28 | * @{ |
@@ -124,8 +124,7 @@ GNUNET_STATISTICS_watch_cancel (struct GNUNET_STATISTICS_Handle *handle, | |||
124 | 124 | ||
125 | 125 | ||
126 | /** | 126 | /** |
127 | * Continuation called by the #GNUNET_STATISTICS_get_all | 127 | * Continuation called by #GNUNET_STATISTICS_get functions. |
128 | * and #GNUNET_STATISTICS_get functions. | ||
129 | * | 128 | * |
130 | * @param cls closure | 129 | * @param cls closure |
131 | * @param success #GNUNET_OK if statistics were | 130 | * @param success #GNUNET_OK if statistics were |
@@ -163,7 +162,7 @@ GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle *handle, | |||
163 | 162 | ||
164 | 163 | ||
165 | /** | 164 | /** |
166 | * Cancel a #GNUNET_STATISICS_get request. Must be called before the 'cont' | 165 | * Cancel a #GNUNET_STATISTICS_get request. Must be called before the 'cont' |
167 | * function is called. | 166 | * function is called. |
168 | * | 167 | * |
169 | * @param gh handle of the request to cancel | 168 | * @param gh handle of the request to cancel |
@@ -174,7 +173,7 @@ GNUNET_STATISTICS_get_cancel (struct GNUNET_STATISTICS_GetHandle *gh); | |||
174 | 173 | ||
175 | /** | 174 | /** |
176 | * Set statistic value for the peer. Will always use our | 175 | * Set statistic value for the peer. Will always use our |
177 | * subsystem (the argument used when "handle" was created). | 176 | * subsystem (the argument used when @a handle was created). |
178 | * | 177 | * |
179 | * @param handle identification of the statistics service | 178 | * @param handle identification of the statistics service |
180 | * @param name name of the statistic value | 179 | * @param name name of the statistic value |
@@ -188,7 +187,7 @@ GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle, | |||
188 | 187 | ||
189 | /** | 188 | /** |
190 | * Set statistic value for the peer. Will always use our | 189 | * Set statistic value for the peer. Will always use our |
191 | * subsystem (the argument used when "handle" was created). | 190 | * subsystem (the argument used when @a handle was created). |
192 | * | 191 | * |
193 | * @param handle identification of the statistics service | 192 | * @param handle identification of the statistics service |
194 | * @param name name of the statistic value | 193 | * @param name name of the statistic value |