fixing documentation
authorChristian Grothoff <christian@grothoff.org>
Thu, 14 Jan 2010 18:24:18 +0000 (18:24 +0000)
committerChristian Grothoff <christian@grothoff.org>
Thu, 14 Jan 2010 18:24:18 +0000 (18:24 +0000)
src/fs/fs_uri.c
src/fs/gnunet-directory.c
src/fs/gnunet-publish.c
src/include/gnunet_transport_service.h
src/peerinfo/gnunet-service-peerinfo.c
src/util/container_meta_data.c
src/util/pseudonym.c

index 16b6e26e980f082ad5b1762f13e30c09e4706613..665f04728f8b04dfbe39aa4f7e1fb5c739b69054 100644 (file)
@@ -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. '<zlib>' for zlib being
+ *        special values can be used (i.e. '&lt;zlib&gt;' for zlib being
  *        used in the main libextractor library and yielding
  *        meta data).
  * @param type libextractor-type describing the meta data
index 3ea76985e6342c245157fd9be91105bcbf7d5a5a..fe2ae8af66508b573f6ced3a73f729d7554ebd40 100644 (file)
@@ -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,
index 65f437f113b856aca648a1911ef81b6ba09864c8..226877b153accd019d87eaa76732a098099d7f5c 100644 (file)
@@ -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
index 74141a383436c4bb9a1da0fce8a4a986178cdef3..a705d3e10e498941b4d6f0706259dbbe7f494a86 100644 (file)
@@ -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);
 
 
 
index 2f56ff2bda527fdc439efee8b89239f8a66541bd..30723be0ba3406b42969af10b9c4646cacdb4c3d 100644 (file)
@@ -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,
index a614f3c4fb62b6b5c1f00a21cbe6e8ee273ba425..b122982d53f3c42e4a4b9bc910f57ef070555236 100644 (file)
@@ -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. '<zlib>' for zlib being
+ *        special values can be used (i.e. '&lt;zlib&gt;' 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. '<zlib>' for zlib being
+ *        special values can be used (i.e. '&lt;zlib&gt;' for zlib being
  *        used in the main libextractor library and yielding
  *        meta data).
  * @param type libextractor-type describing the meta data
index 626e8ca9999cf0769c7ff53454a2df5fb9948e83..07c05b9e67bb8e56cecdf9a3aa1b2a4879d8f55e 100644 (file)
@@ -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,