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_identity_service.h | |
parent | 1fca0c918c8468ba16666e8a1c41526cacdc6df2 (diff) | |
download | gnunet-5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b.tar.gz gnunet-5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b.zip |
-misc doxygen fixes
Diffstat (limited to 'src/include/gnunet_identity_service.h')
-rw-r--r-- | src/include/gnunet_identity_service.h | 37 |
1 files changed, 21 insertions, 16 deletions
diff --git a/src/include/gnunet_identity_service.h b/src/include/gnunet_identity_service.h index 23dee600f..1d682cb1e 100644 --- a/src/include/gnunet_identity_service.h +++ b/src/include/gnunet_identity_service.h | |||
@@ -30,7 +30,10 @@ | |||
30 | * manages the egos (private keys) of the local user; it does | 30 | * manages the egos (private keys) of the local user; it does |
31 | * NOT manage identities of other users (public keys). For giving | 31 | * NOT manage identities of other users (public keys). For giving |
32 | * names to other users and manage their public keys securely, we | 32 | * names to other users and manage their public keys securely, we |
33 | * use GADS/GNS. | 33 | * use GNS. |
34 | * | ||
35 | * @defgroup identity identity management service | ||
36 | * @{ | ||
34 | */ | 37 | */ |
35 | #ifndef GNUNET_IDENTITY_SERVICE_H | 38 | #ifndef GNUNET_IDENTITY_SERVICE_H |
36 | #define GNUNET_IDENTITY_SERVICE_H | 39 | #define GNUNET_IDENTITY_SERVICE_H |
@@ -101,27 +104,27 @@ GNUNET_IDENTITY_ego_get_public_key (const struct GNUNET_IDENTITY_Ego *ego, | |||
101 | * Method called to inform about the egos of | 104 | * Method called to inform about the egos of |
102 | * this peer. | 105 | * this peer. |
103 | * | 106 | * |
104 | * When used with 'GNUNET_IDENTITY_connect', this function is | 107 | * When used with #GNUNET_IDENTITY_connect, this function is |
105 | * initially called for all egos and then again whenever a | 108 | * initially called for all egos and then again whenever a |
106 | * ego's name changes or if it is deleted. At the end of | 109 | * ego's name changes or if it is deleted. At the end of |
107 | * the initial pass over all egos, the function is once called | 110 | * the initial pass over all egos, the function is once called |
108 | * with 'NULL' for 'ego'. That does NOT mean that the callback won't | 111 | * with 'NULL' for @a ego. That does NOT mean that the callback won't |
109 | * be invoked in the future or that there was an error. | 112 | * be invoked in the future or that there was an error. |
110 | * | 113 | * |
111 | * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', | 114 | * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, |
112 | * this function is only called ONCE, and 'NULL' being passed in | 115 | * this function is only called ONCE, and 'NULL' being passed in |
113 | * 'ego' does indicate an error (i.e. name is taken or no default | 116 | * @a ego does indicate an error (i.e. name is taken or no default |
114 | * value is known). If 'ego' is non-NULL and if '*ctx' | 117 | * value is known). If @a ego is non-NULL and if '*ctx' |
115 | * is set in those callbacks, the value WILL be passed to a subsequent | 118 | * is set in those callbacks, the value WILL be passed to a subsequent |
116 | * call to the identity callback of 'GNUNET_IDENTITY_connect' (if | 119 | * call to the identity callback of #GNUNET_IDENTITY_connect (if |
117 | * that one was not NULL). | 120 | * that one was not NULL). |
118 | * | 121 | * |
119 | * When an identity is renamed, this function is called with the | 122 | * When an identity is renamed, this function is called with the |
120 | * (known) ego but the NEW name. | 123 | * (known) @a ego but the NEW @a name. |
121 | * | 124 | * |
122 | * When an identity is deleted, this function is called with the | 125 | * When an identity is deleted, this function is called with the |
123 | * (known) ego and "NULL" for the 'name'. In this case, | 126 | * (known) ego and "NULL" for the @a name. In this case, |
124 | * the 'ego' is henceforth invalid (and the 'ctx' should also be | 127 | * the @a ego is henceforth invalid (and the @a ctx should also be |
125 | * cleaned up). | 128 | * cleaned up). |
126 | * | 129 | * |
127 | * @param cls closure | 130 | * @param cls closure |
@@ -143,7 +146,7 @@ typedef void (*GNUNET_IDENTITY_Callback)(void *cls, | |||
143 | * | 146 | * |
144 | * @param cfg Configuration to contact the identity service. | 147 | * @param cfg Configuration to contact the identity service. |
145 | * @param cb function to call on all identity events, can be NULL | 148 | * @param cb function to call on all identity events, can be NULL |
146 | * @param cb_cls closure for 'cb' | 149 | * @param cb_cls closure for @a cb |
147 | * @return handle to communicate with identity service | 150 | * @return handle to communicate with identity service |
148 | */ | 151 | */ |
149 | struct GNUNET_IDENTITY_Handle * | 152 | struct GNUNET_IDENTITY_Handle * |
@@ -159,7 +162,7 @@ GNUNET_IDENTITY_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, | |||
159 | * @param id identity service to query | 162 | * @param id identity service to query |
160 | * @param service_name for which service is an identity wanted | 163 | * @param service_name for which service is an identity wanted |
161 | * @param cb function to call with the result (will only be called once) | 164 | * @param cb function to call with the result (will only be called once) |
162 | * @param cb_cls closure for cb | 165 | * @param cb_cls closure for @a cb |
163 | * @return handle to abort the operation | 166 | * @return handle to abort the operation |
164 | */ | 167 | */ |
165 | struct GNUNET_IDENTITY_Operation * | 168 | struct GNUNET_IDENTITY_Operation * |
@@ -187,7 +190,7 @@ typedef void (*GNUNET_IDENTITY_Continuation)(void *cls, | |||
187 | * @param service_name for which service is an identity set | 190 | * @param service_name for which service is an identity set |
188 | * @param ego new default identity to be set for this service | 191 | * @param ego new default identity to be set for this service |
189 | * @param cont function to call once the operation finished | 192 | * @param cont function to call once the operation finished |
190 | * @param cont_cls closure for cont | 193 | * @param cont_cls closure for @a cont |
191 | * @return handle to abort the operation | 194 | * @return handle to abort the operation |
192 | */ | 195 | */ |
193 | struct GNUNET_IDENTITY_Operation * | 196 | struct GNUNET_IDENTITY_Operation * |
@@ -213,7 +216,7 @@ GNUNET_IDENTITY_disconnect (struct GNUNET_IDENTITY_Handle *h); | |||
213 | * @param id identity service to use | 216 | * @param id identity service to use |
214 | * @param name desired name | 217 | * @param name desired name |
215 | * @param cont function to call with the result (will only be called once) | 218 | * @param cont function to call with the result (will only be called once) |
216 | * @param cont_cls closure for cont | 219 | * @param cont_cls closure for @a cont |
217 | * @return handle to abort the operation | 220 | * @return handle to abort the operation |
218 | */ | 221 | */ |
219 | struct GNUNET_IDENTITY_Operation * | 222 | struct GNUNET_IDENTITY_Operation * |
@@ -230,7 +233,7 @@ GNUNET_IDENTITY_create (struct GNUNET_IDENTITY_Handle *id, | |||
230 | * @param old_name old name | 233 | * @param old_name old name |
231 | * @param new_name desired new name | 234 | * @param new_name desired new name |
232 | * @param cb function to call with the result (will only be called once) | 235 | * @param cb function to call with the result (will only be called once) |
233 | * @param cb_cls closure for cb | 236 | * @param cb_cls closure for @a cb |
234 | * @return handle to abort the operation | 237 | * @return handle to abort the operation |
235 | */ | 238 | */ |
236 | struct GNUNET_IDENTITY_Operation * | 239 | struct GNUNET_IDENTITY_Operation * |
@@ -247,7 +250,7 @@ GNUNET_IDENTITY_rename (struct GNUNET_IDENTITY_Handle *id, | |||
247 | * @param id identity service to use | 250 | * @param id identity service to use |
248 | * @param name name of the identity to delete | 251 | * @param name name of the identity to delete |
249 | * @param cb function to call with the result (will only be called once) | 252 | * @param cb function to call with the result (will only be called once) |
250 | * @param cb_cls closure for cb | 253 | * @param cb_cls closure for @a cb |
251 | * @return handle to abort the operation | 254 | * @return handle to abort the operation |
252 | */ | 255 | */ |
253 | struct GNUNET_IDENTITY_Operation * | 256 | struct GNUNET_IDENTITY_Operation * |
@@ -276,6 +279,8 @@ GNUNET_IDENTITY_cancel (struct GNUNET_IDENTITY_Operation *op); | |||
276 | } | 279 | } |
277 | #endif | 280 | #endif |
278 | 281 | ||
282 | /** @} */ /* end of group identity */ | ||
283 | |||
279 | /* ifndef GNUNET_IDENTITY_SERVICE_H */ | 284 | /* ifndef GNUNET_IDENTITY_SERVICE_H */ |
280 | #endif | 285 | #endif |
281 | /* end of gnunet_identity_service.h */ | 286 | /* end of gnunet_identity_service.h */ |