From: Christian Grothoff Date: Thu, 14 Jan 2010 18:24:18 +0000 (+0000) Subject: fixing documentation X-Git-Tag: initial-import-from-subversion-38251~22976 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=76fe0e518c1b00878102777513f53e754eb20013;p=oweals%2Fgnunet.git fixing documentation --- diff --git a/src/fs/fs_uri.c b/src/fs/fs_uri.c index 16b6e26e9..665f04728 100644 --- a/src/fs/fs_uri.c +++ b/src/fs/fs_uri.c @@ -1470,7 +1470,7 @@ GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri) * * @param cls URI to update * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '' for zlib being + * special values can be used (i.e. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data diff --git a/src/fs/gnunet-directory.c b/src/fs/gnunet-directory.c index 3ea76985e..fe2ae8af6 100644 --- a/src/fs/gnunet-directory.c +++ b/src/fs/gnunet-directory.c @@ -32,7 +32,11 @@ static int ret; * * @param cls closure (unused) * @param type type of the keyword - * @param data value of the keyword + * @param format format of data + * @param data_mime_type mime type of data + * @param data value of the meta data + * @param data_size number of bytes in data + * @return always 0 (to continue iterating) */ static int item_printer (void *cls, diff --git a/src/fs/gnunet-publish.c b/src/fs/gnunet-publish.c index 65f437f11..226877b15 100644 --- a/src/fs/gnunet-publish.c +++ b/src/fs/gnunet-publish.c @@ -139,7 +139,10 @@ progress_cb (void *cls, * * @param cls closure * @param type type of the meta data + * @param format format of data + * @param data_mime_type mime type of data * @param data value of the meta data + * @param data_size number of bytes in data * @return always 0 */ static int @@ -169,7 +172,10 @@ meta_printer (void *cls, * * @param cls closure, target metadata structure * @param type type of the meta data + * @param format format of data + * @param data_mime_type mime type of data * @param data value of the meta data + * @param data_size number of bytes in data * @return always 0 */ static int diff --git a/src/include/gnunet_transport_service.h b/src/include/gnunet_transport_service.h index 74141a383..a705d3e10 100644 --- a/src/include/gnunet_transport_service.h +++ b/src/include/gnunet_transport_service.h @@ -235,10 +235,17 @@ GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle, const struct GNUNET_MessageHeader *hello); /** - * Obtain a AddressLookupMessage from a client and return to client all the host addresses of other peers. + * Convert a binary address into a human + * readable address. * - * @param handle connection to transport service - * @param addLUmsg the address-lookup message + * @param handle connection to transport service + * @param cfg configuration to use + * @param address address to convert (binary format) + * @param addressLen number of bytes in address + * @param nameTrans name of the transport to which the address belongs + * @param timeout how long is the lookup allowed to take at most + * @param aluc function to call with the results + * @param aluc_cls closure for aluc */ void GNUNET_TRANSPORT_address_lookup (struct GNUNET_SCHEDULER_Handle *sched, @@ -246,9 +253,9 @@ GNUNET_TRANSPORT_address_lookup (struct GNUNET_SCHEDULER_Handle *sched, const char * address, size_t addressLen, const char * nameTrans, - struct GNUNET_TIME_Relative timeout, - GNUNET_TRANSPORT_AddressLookUpCallback aluc, - void *aluc_cls); + struct GNUNET_TIME_Relative timeout, + GNUNET_TRANSPORT_AddressLookUpCallback aluc, + void *aluc_cls); diff --git a/src/peerinfo/gnunet-service-peerinfo.c b/src/peerinfo/gnunet-service-peerinfo.c index 2f56ff2bd..30723be0b 100644 --- a/src/peerinfo/gnunet-service-peerinfo.c +++ b/src/peerinfo/gnunet-service-peerinfo.c @@ -220,7 +220,7 @@ transmit_pending_notification (void *cls, * list was previously empty. * * @param nl client to notify - * @param hc entry to notify about + * @param he entry to notify about */ static void do_notify (struct NotifyList *nl, diff --git a/src/util/container_meta_data.c b/src/util/container_meta_data.c index a614f3c4f..b122982d5 100644 --- a/src/util/container_meta_data.c +++ b/src/util/container_meta_data.c @@ -227,7 +227,7 @@ GNUNET_CONTAINER_meta_data_test_equal (const struct GNUNET_CONTAINER_MetaData * * @param md metadata to extend * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '' for zlib being + * special values can be used (i.e. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data @@ -565,7 +565,7 @@ GNUNET_CONTAINER_meta_data_duplicate (const struct GNUNET_CONTAINER_MetaData * * @param cls closure, our meta data container * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '' for zlib being + * special values can be used (i.e. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data diff --git a/src/util/pseudonym.c b/src/util/pseudonym.c index 626e8ca99..07c05b9e6 100644 --- a/src/util/pseudonym.c +++ b/src/util/pseudonym.c @@ -541,7 +541,11 @@ GNUNET_PSEUDONYM_rank (const struct GNUNET_CONFIGURATION_Handle *cfg, * * @param cls metadata to add to * @param type type of entry to insert - * @param data value of entry to insert + * @param format format of data + * @param data_mime_type mime type of data + * @param data value of the meta data + * @param data_size number of bytes in data + * @return always 0 */ static int merge_meta_helper (void *cls,