From ebfd8a07a7380540ce0216861ffe23e5b303be19 Mon Sep 17 00:00:00 2001 From: Matthias Wachs Date: Mon, 5 Mar 2012 12:24:58 +0000 Subject: [PATCH] - doxygen --- src/dv/plugin_transport_dv.c | 4 +--- src/include/gnunet_gns_service.h | 2 -- src/include/gnunet_namestore_service.h | 6 +++--- src/namestore/gnunet-service-namestore.c | 1 + src/namestore/namestore.h | 11 ++++++++++- src/namestore/namestore_common.c | 19 ++++++++++++++++--- 6 files changed, 31 insertions(+), 12 deletions(-) diff --git a/src/dv/plugin_transport_dv.c b/src/dv/plugin_transport_dv.c index 8ee49c519..3a8bafcef 100644 --- a/src/dv/plugin_transport_dv.c +++ b/src/dv/plugin_transport_dv.c @@ -385,9 +385,7 @@ dv_plugin_check_address (void *cls, const void *addr, size_t addrlen) * notify us by calling the env->session_end function * * @param cls the plugin - * @param target the neighbour id - * @param addr pointer to the address - * @param addrlen length of addr + * @param address the address * @return the session if the address is valid, NULL otherwise */ static struct Session * diff --git a/src/include/gnunet_gns_service.h b/src/include/gnunet_gns_service.h index 242217866..f7bfc2aa7 100644 --- a/src/include/gnunet_gns_service.h +++ b/src/include/gnunet_gns_service.h @@ -121,8 +121,6 @@ typedef void (*GNUNET_GNS_LookupIterator) (void *cls, * @param handle handle to the GNS service * @param timeout how long to wait for transmission of this request to the service * // FIXME: what happens afterwards? - * @param handle handle to the GNS service - * @param timeout timeout of request * @param name the name to look up * @param type the GNUNET_GNS_RecordType to look for * @param iter function to call on each result diff --git a/src/include/gnunet_namestore_service.h b/src/include/gnunet_namestore_service.h index a8233fa4b..f3ea765fd 100644 --- a/src/include/gnunet_namestore_service.h +++ b/src/include/gnunet_namestore_service.h @@ -111,7 +111,7 @@ GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h, int drop); * * @param cls closure * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate) - * GNUNET_NO if content was already there + * GNUNET_NO if content was already there or not found * GNUNET_YES (or other positive value) on success * @param emsg NULL on success, otherwise an error message */ @@ -419,7 +419,7 @@ GNUNET_NAMESTORE_records_get_size (unsigned int rd_count, /** * Serialize the given records to the given destination buffer. * - * @param rd_cound number of records in the rd array + * @param rd_count number of records in the rd array * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements * @param dest_size size of the destination array * @param dest where to write the result @@ -438,7 +438,7 @@ GNUNET_NAMESTORE_records_serialize (unsigned int rd_count, * * @param len size of the serialized record data * @param src the serialized record data - * @param rd_cound number of records in the rd array + * @param rd_count number of records in the rd array * @param dest where to put the data * * @return GNUNET_OK on success, GNUNET_SYSERR on error diff --git a/src/namestore/gnunet-service-namestore.c b/src/namestore/gnunet-service-namestore.c index 23d45d080..600965e8a 100644 --- a/src/namestore/gnunet-service-namestore.c +++ b/src/namestore/gnunet-service-namestore.c @@ -225,6 +225,7 @@ void drop_iterator (void *cls, * * @param cls closure * @param client identification of the client + * @param message the stop message */ static void handle_stop (void *cls, struct GNUNET_SERVER_Client * client, diff --git a/src/namestore/namestore.h b/src/namestore/namestore.h index a70d3a62c..f8aa71f0e 100644 --- a/src/namestore/namestore.h +++ b/src/namestore/namestore.h @@ -45,7 +45,16 @@ #define GNUNET_MESSAGE_TYPE_NAMESTORE_DISCONNECT 443 - +/** + * Sign name and records + * + * @param key the private key + * @param name the name + * @param rd record data + * @param rd_count number of records + * + * @return the signature + */ struct GNUNET_CRYPTO_RsaSignature * GNUNET_NAMESTORE_create_signature (const struct GNUNET_CRYPTO_RsaPrivateKey *key, const char *name, struct GNUNET_NAMESTORE_RecordData *rd, unsigned int rd_count); diff --git a/src/namestore/namestore_common.c b/src/namestore/namestore_common.c index 2e0a58c62..c1b5ddc1e 100644 --- a/src/namestore/namestore_common.c +++ b/src/namestore/namestore_common.c @@ -95,7 +95,7 @@ GNUNET_NAMESTORE_records_get_size (unsigned int rd_count, /** * Serialize the given records to the given destination buffer. * - * @param rd_cound number of records in the rd array + * @param rd_count number of records in the rd array * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements * @param dest_size size of the destination array * @param dest where to write the result @@ -158,7 +158,7 @@ GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a, * * @param len size of the serialized record data * @param src the serialized record data - * @param rd_cound number of records in the rd array + * @param rd_count number of records in the rd array * @param dest where to put the data * * @return GNUNET_OK on success, GNUNET_SYSERR on error @@ -193,8 +193,21 @@ GNUNET_NAMESTORE_records_deserialize (size_t len, return GNUNET_OK; } +/** + * Sign name and records + * + * @param key the private key + * @param name the name + * @param rd record data + * @param rd_count number of records + * + * @return the signature + */ struct GNUNET_CRYPTO_RsaSignature * -GNUNET_NAMESTORE_create_signature (const struct GNUNET_CRYPTO_RsaPrivateKey *key, const char *name, struct GNUNET_NAMESTORE_RecordData *rd, unsigned int rd_count) +GNUNET_NAMESTORE_create_signature (const struct GNUNET_CRYPTO_RsaPrivateKey *key, + const char *name, + struct GNUNET_NAMESTORE_RecordData *rd, + unsigned int rd_count) { struct GNUNET_CRYPTO_RsaSignature *sig = GNUNET_malloc(sizeof (struct GNUNET_CRYPTO_RsaSignature)); struct GNUNET_CRYPTO_RsaSignaturePurpose *sig_purpose; -- 2.25.1