diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-08-21 15:16:58 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-08-21 15:16:58 +0000 |
commit | 5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b (patch) | |
tree | 7ba261fc1882bcfa6dc0da916272a0ed0d17468e /src/include/gnunet_statistics_service.h | |
parent | 1fca0c918c8468ba16666e8a1c41526cacdc6df2 (diff) | |
download | gnunet-5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b.tar.gz gnunet-5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b.zip |
-misc doxygen fixes
Diffstat (limited to 'src/include/gnunet_statistics_service.h')
-rw-r--r-- | src/include/gnunet_statistics_service.h | 35 |
1 files changed, 21 insertions, 14 deletions
diff --git a/src/include/gnunet_statistics_service.h b/src/include/gnunet_statistics_service.h index 5e41edc5b..c2fb46109 100644 --- a/src/include/gnunet_statistics_service.h +++ b/src/include/gnunet_statistics_service.h | |||
@@ -1,10 +1,10 @@ | |||
1 | /* | 1 | /* |
2 | This file is part of GNUnet | 2 | This file is part of GNUnet |
3 | (C) 2009, 2010 Christian Grothoff (and other contributing authors) | 3 | (C) 2009-2013 Christian Grothoff (and other contributing authors) |
4 | 4 | ||
5 | GNUnet is free software; you can redistribute it and/or modify | 5 | GNUnet is free software; you can redistribute it and/or modify |
6 | it under the terms of the GNU General Public License as published | 6 | it under the terms of the GNU General Public License as published |
7 | by the Free Software Foundation; either version 2, or (at your | 7 | by the Free Software Foundation; either version 3, or (at your |
8 | option) any later version. | 8 | option) any later version. |
9 | 9 | ||
10 | GNUnet is distributed in the hope that it will be useful, but | 10 | GNUnet is distributed in the hope that it will be useful, but |
@@ -24,6 +24,8 @@ | |||
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 | ||
28 | * @{ | ||
27 | */ | 29 | */ |
28 | 30 | ||
29 | #ifndef GNUNET_STATISTICS_SERVICE_H | 31 | #ifndef GNUNET_STATISTICS_SERVICE_H |
@@ -58,8 +60,8 @@ struct GNUNET_STATISTICS_Handle; | |||
58 | * @param subsystem name of subsystem that created the statistic | 60 | * @param subsystem name of subsystem that created the statistic |
59 | * @param name the name of the datum | 61 | * @param name the name of the datum |
60 | * @param value the current value | 62 | * @param value the current value |
61 | * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not | 63 | * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not |
62 | * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration | 64 | * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration |
63 | */ | 65 | */ |
64 | typedef int (*GNUNET_STATISTICS_Iterator) (void *cls, const char *subsystem, | 66 | typedef int (*GNUNET_STATISTICS_Iterator) (void *cls, const char *subsystem, |
65 | const char *name, uint64_t value, | 67 | const char *name, uint64_t value, |
@@ -82,7 +84,7 @@ GNUNET_STATISTICS_create (const char *subsystem, | |||
82 | * it). | 84 | * it). |
83 | * | 85 | * |
84 | * @param h statistics handle to destroy | 86 | * @param h statistics handle to destroy |
85 | * @param sync_first set to GNUNET_YES if pending SET requests should | 87 | * @param sync_first set to #GNUNET_YES if pending SET requests should |
86 | * be completed | 88 | * be completed |
87 | */ | 89 | */ |
88 | void | 90 | void |
@@ -96,8 +98,8 @@ GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *h, int sync_first); | |||
96 | * @param subsystem limit to the specified subsystem, never NULL | 98 | * @param subsystem limit to the specified subsystem, never NULL |
97 | * @param name name of the statistic value, never NULL | 99 | * @param name name of the statistic value, never NULL |
98 | * @param proc function to call on each value | 100 | * @param proc function to call on each value |
99 | * @param proc_cls closure for proc | 101 | * @param proc_cls closure for @a proc |
100 | * @return GNUNET_OK on success, GNUNET_SYSERR on error | 102 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
101 | */ | 103 | */ |
102 | int | 104 | int |
103 | GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle, | 105 | GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle, |
@@ -112,8 +114,8 @@ GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle, | |||
112 | * @param subsystem limit to the specified subsystem, never NULL | 114 | * @param subsystem limit to the specified subsystem, never NULL |
113 | * @param name name of the statistic value, never NULL | 115 | * @param name name of the statistic value, never NULL |
114 | * @param proc function to call on each value | 116 | * @param proc function to call on each value |
115 | * @param proc_cls closure for proc | 117 | * @param proc_cls closure for @a proc |
116 | * @return GNUNET_OK on success, GNUNET_SYSERR on error (no such watch) | 118 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error (no such watch) |
117 | */ | 119 | */ |
118 | int | 120 | int |
119 | GNUNET_STATISTICS_watch_cancel (struct GNUNET_STATISTICS_Handle *handle, | 121 | GNUNET_STATISTICS_watch_cancel (struct GNUNET_STATISTICS_Handle *handle, |
@@ -122,11 +124,12 @@ GNUNET_STATISTICS_watch_cancel (struct GNUNET_STATISTICS_Handle *handle, | |||
122 | 124 | ||
123 | 125 | ||
124 | /** | 126 | /** |
125 | * Continuation called by the "get_all" and "get" functions. | 127 | * Continuation called by the #GNUNET_STATISTICS_get_all |
128 | * and #GNUNET_STATISTICS_get functions. | ||
126 | * | 129 | * |
127 | * @param cls closure | 130 | * @param cls closure |
128 | * @param success GNUNET_OK if statistics were | 131 | * @param success #GNUNET_OK if statistics were |
129 | * successfully obtained, GNUNET_SYSERR if not. | 132 | * successfully obtained, #GNUNET_SYSERR if not. |
130 | */ | 133 | */ |
131 | typedef void (*GNUNET_STATISTICS_Callback) (void *cls, int success); | 134 | typedef void (*GNUNET_STATISTICS_Callback) (void *cls, int success); |
132 | 135 | ||
@@ -136,6 +139,7 @@ typedef void (*GNUNET_STATISTICS_Callback) (void *cls, int success); | |||
136 | */ | 139 | */ |
137 | struct GNUNET_STATISTICS_GetHandle; | 140 | struct GNUNET_STATISTICS_GetHandle; |
138 | 141 | ||
142 | |||
139 | /** | 143 | /** |
140 | * Get statistic from the peer. | 144 | * Get statistic from the peer. |
141 | * | 145 | * |
@@ -147,7 +151,7 @@ struct GNUNET_STATISTICS_GetHandle; | |||
147 | * @param cont continuation to call when done (can be NULL) | 151 | * @param cont continuation to call when done (can be NULL) |
148 | * This callback CANNOT destroy the statistics handle in the same call. | 152 | * This callback CANNOT destroy the statistics handle in the same call. |
149 | * @param proc function to call on each value | 153 | * @param proc function to call on each value |
150 | * @param cls closure for proc and cont | 154 | * @param cls closure for @a proc and @a cont |
151 | * @return NULL on error | 155 | * @return NULL on error |
152 | */ | 156 | */ |
153 | struct GNUNET_STATISTICS_GetHandle * | 157 | struct GNUNET_STATISTICS_GetHandle * |
@@ -159,7 +163,7 @@ GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle *handle, | |||
159 | 163 | ||
160 | 164 | ||
161 | /** | 165 | /** |
162 | * Cancel a 'get' request. Must be called before the 'cont' | 166 | * Cancel a #GNUNET_STATISICS_get request. Must be called before the 'cont' |
163 | * function is called. | 167 | * function is called. |
164 | * | 168 | * |
165 | * @param gh handle of the request to cancel | 169 | * @param gh handle of the request to cancel |
@@ -181,6 +185,7 @@ void | |||
181 | GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle, | 185 | GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle, |
182 | const char *name, uint64_t value, int make_persistent); | 186 | const char *name, uint64_t value, int make_persistent); |
183 | 187 | ||
188 | |||
184 | /** | 189 | /** |
185 | * Set statistic value for the peer. Will always use our | 190 | * Set statistic value for the peer. Will always use our |
186 | * subsystem (the argument used when "handle" was created). | 191 | * subsystem (the argument used when "handle" was created). |
@@ -203,4 +208,6 @@ GNUNET_STATISTICS_update (struct GNUNET_STATISTICS_Handle *handle, | |||
203 | } | 208 | } |
204 | #endif | 209 | #endif |
205 | 210 | ||
211 | /** @} */ /* end of group statistics */ | ||
212 | |||
206 | #endif | 213 | #endif |