From: Christian Grothoff <christian@grothoff.org>
Date: Mon, 28 Nov 2011 15:56:09 +0000 (+0000)
Subject: -doxygen fixes
X-Git-Tag: initial-import-from-subversion-38251~15776
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=7860a8fa9e6cca9f59efbfee307a01545578f59f;p=oweals%2Fgnunet.git

-doxygen fixes
---

diff --git a/src/ats/ats_api_performance.c b/src/ats/ats_api_performance.c
index 8ac88ec63..f85d800e4 100644
--- a/src/ats/ats_api_performance.c
+++ b/src/ats/ats_api_performance.c
@@ -193,7 +193,7 @@ reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  * Transmit messages from the message queue to the service
  * (if there are any, and if we are not already trying).
  *
- * @param sh handle to use
+ * @param ph handle to use
  */
 static void
 do_transmit (struct GNUNET_ATS_PerformanceHandle *ph);
diff --git a/src/ats/gnunet-service-ats_math.c b/src/ats/gnunet-service-ats_math.c
index 8d25e25c6..c5e68b153 100644
--- a/src/ats/gnunet-service-ats_math.c
+++ b/src/ats/gnunet-service-ats_math.c
@@ -19,8 +19,8 @@
 */
 
 /**
- * @file transport/gnunet-service-transport_ats.c
- * @brief automatic transport selection
+ * @file transport/gnunet-service-transport_math.c
+ * @brief automatic transport selection, LP code
  * @author Matthias Wachs
  *
  */
@@ -506,10 +506,8 @@ _dummy2 ()
 
 /**
  * Initialize ATS
- * @param cfg configuration handle to retrieve configuration (to be removed)
  * @return
  */
-
 struct ATS_Handle *
 ats_init (double D, double U, double R, int v_b_min, int v_n_min,
           int max_iterations, struct GNUNET_TIME_Relative max_duration,
diff --git a/src/ats/gnunet-service-ats_math.h b/src/ats/gnunet-service-ats_math.h
index 0ec85f3f0..9ce9dd2cf 100644
--- a/src/ats/gnunet-service-ats_math.h
+++ b/src/ats/gnunet-service-ats_math.h
@@ -19,12 +19,12 @@
 */
 
 /**
- * @file transport/gnunet-service-transport_ats.h
+ * @file transport/gnunet-service-ats_math.h
  * @brief common internal definitions for transport service's ats code
  * @author Matthias Wachs
  */
-#ifndef GNUNET_SERVICE_TRANSPORT_ATS_H
-#define GNUNET_SERVICE_TRANSPORT_ATS_H
+#ifndef GNUNET_SERVICE_TRANSPORT_MATH_H
+#define GNUNET_SERVICE_TRANSPORT_MATH_H
 
 #include "platform.h"
 #include "gnunet_constants.h"
diff --git a/src/ats/gnunet-service-ats_performance.c b/src/ats/gnunet-service-ats_performance.c
index 4b8d23720..b12765620 100644
--- a/src/ats/gnunet-service-ats_performance.c
+++ b/src/ats/gnunet-service-ats_performance.c
@@ -98,6 +98,7 @@ find_client (struct GNUNET_SERVER_Client *client)
  * Register a new performance client.
  *
  * @param client handle of the new client
+ * @param flag flag specifying the type of the client
  */
 void
 GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
diff --git a/src/ats/gnunet-service-ats_performance.h b/src/ats/gnunet-service-ats_performance.h
index 44d02452b..75d555a6c 100644
--- a/src/ats/gnunet-service-ats_performance.h
+++ b/src/ats/gnunet-service-ats_performance.h
@@ -35,7 +35,7 @@
  * Register a new performance client.
  *
  * @param client handle of the new client
- * @param flag options for the client
+ * @param flag flag specifying the type of the client
  */
 void
 GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
diff --git a/src/core/gnunet-service-core_clients.c b/src/core/gnunet-service-core_clients.c
index 5d06af640..5448d5d0f 100644
--- a/src/core/gnunet-service-core_clients.c
+++ b/src/core/gnunet-service-core_clients.c
@@ -207,6 +207,8 @@ type_match (uint16_t type, struct GSC_Client *c)
  * Send a message to all of our current clients that have the right
  * options set.
  *
+ * @param sender origin of the message (used to check that this peer is
+ *        known to be connected to the respective client)
  * @param msg message to multicast
  * @param can_drop can this message be discarded if the queue is too long
  * @param options mask to use
@@ -659,7 +661,6 @@ GSC_CLIENTS_reject_request (struct GSC_ClientActiveRequest *car)
  * @param atsi_count number of entries in 'ats' array
  * @param tmap_old previous type map for the neighbour, NULL for disconnect
  * @param tmap_new updated type map for the neighbour, NULL for disconnect
- * @param is_new GNUNET_YES if this is a completely new neighbour
  */
 void
 GSC_CLIENTS_notify_client_about_neighbour (struct GSC_Client *client,
diff --git a/src/core/gnunet-service-core_kx.c b/src/core/gnunet-service-core_kx.c
index d49e06e2a..63dd6b7ee 100644
--- a/src/core/gnunet-service-core_kx.c
+++ b/src/core/gnunet-service-core_kx.c
@@ -1068,7 +1068,7 @@ update_timeout (struct GSC_KeyExchangeInfo *kx)
  * We received a PONG message.  Validate and update our status.
  *
  * @param kx key exchange context for the the PONG
- * @param m the encrypted PONG message itself
+ * @param msg the encrypted PONG message itself
  */
 void
 GSC_KX_handle_pong (struct GSC_KeyExchangeInfo *kx,
@@ -1322,7 +1322,7 @@ struct DeliverMessageContext
  * pass on to the appropriate clients.
  *
  * @param kx key exchange context for encrypting the message
- * @param m encrypted message
+ * @param msg encrypted message
  * @param atsi performance data
  * @param atsi_count number of entries in ats (excluding 0-termination)
  */
diff --git a/src/core/gnunet-service-core_typemap.c b/src/core/gnunet-service-core_typemap.c
index d3214ea67..d2dab5d99 100644
--- a/src/core/gnunet-service-core_typemap.c
+++ b/src/core/gnunet-service-core_typemap.c
@@ -205,7 +205,7 @@ GSC_TYPEMAP_remove (const uint16_t * types, unsigned int tlen)
  * Test if any of the types from the types array is in the
  * given type map.
  *
- * @param map map to test
+ * @param tmap map to test
  * @param types array of types
  * @param tcnt number of entries in types
  * @return GNUNET_YES if a type is in the map, GNUNET_NO if not
@@ -230,7 +230,7 @@ GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap, const uint16_t * types,
 /**
  * Add additional types to a given typemap.
  *
- * @param map map to extend (not changed)
+ * @param tmap map to extend (not changed)
  * @param types array of types to add
  * @param tcnt number of entries in types
  * @return updated type map (fresh copy)
@@ -254,7 +254,7 @@ GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap, const uint16_t * types,
 /**
  * Create an empty type map.
  *
- * @param map a type map
+ * @return an empty type map
  */
 struct GSC_TypeMap *
 GSC_TYPEMAP_create ()
@@ -266,7 +266,7 @@ GSC_TYPEMAP_create ()
 /**
  * Free the given type map.
  *
- * @param map a type map
+ * @param tmap a type map
  */
 void
 GSC_TYPEMAP_destroy (struct GSC_TypeMap *tmap)
diff --git a/src/core/gnunet-service-core_typemap.h b/src/core/gnunet-service-core_typemap.h
index ab106a161..aee4573b6 100644
--- a/src/core/gnunet-service-core_typemap.h
+++ b/src/core/gnunet-service-core_typemap.h
@@ -72,7 +72,7 @@ GSC_TYPEMAP_get_from_message (const struct GNUNET_MessageHeader *msg);
  * Test if any of the types from the types array is in the
  * given type map.
  *
- * @param map map to test
+ * @param tmap map to test
  * @param types array of types
  * @param tcnt number of entries in types
  * @return GNUNET_YES if a type is in the map, GNUNET_NO if not
@@ -85,7 +85,7 @@ GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap, const uint16_t * types,
 /**
  * Add additional types to a given typemap.
  *
- * @param map map to extend (not changed)
+ * @param tmap map to extend (not changed)
  * @param types array of types to add
  * @param tcnt number of entries in types
  * @return updated type map (fresh copy)
@@ -97,7 +97,7 @@ GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap, const uint16_t * types,
 /**
  * Create an empty type map.
  *
- * @param map a type map
+ * @return an empty type map
  */
 struct GSC_TypeMap *
 GSC_TYPEMAP_create (void);
@@ -106,7 +106,7 @@ GSC_TYPEMAP_create (void);
 /**
  * Free the given type map.
  *
- * @param map a type map
+ * @param tmap a type map
  */
 void
 GSC_TYPEMAP_destroy (struct GSC_TypeMap *tmap);
diff --git a/src/dht/gnunet-service-dht_hello.c b/src/dht/gnunet-service-dht_hello.c
index 578e651f8..b9cc45016 100644
--- a/src/dht/gnunet-service-dht_hello.c
+++ b/src/dht/gnunet-service-dht_hello.c
@@ -64,7 +64,7 @@ GDS_HELLO_get (const struct GNUNET_PeerIdentity *peer)
  * @param cls closure
  * @param peer id of the peer, NULL for last call
  * @param hello hello message for the peer (can be NULL)
- * @param error message
+ * @param err_msg error message (not used)
  */
 static void
 process_hello (void *cls, const struct GNUNET_PeerIdentity *peer,
diff --git a/src/dht/plugin_block_dht.c b/src/dht/plugin_block_dht.c
index f574e6d06..19467b9c9 100644
--- a/src/dht/plugin_block_dht.c
+++ b/src/dht/plugin_block_dht.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file block/plugin_block_dht.c
+ * @file dht/plugin_block_dht.c
  * @brief block plugin for DHT internals (right now, find-peer requests only);
  *        other plugins should be used to store "useful" data in the
  *        DHT (see fs block plugin)
diff --git a/src/fs/fs_file_information.c b/src/fs/fs_file_information.c
index b094ed7d5..0925d57ec 100644
--- a/src/fs/fs_file_information.c
+++ b/src/fs/fs_file_information.c
@@ -477,7 +477,7 @@ struct MetaValueInformation
  *
  * @param cls the container multihashmap 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
diff --git a/src/fs/plugin_block_fs.c b/src/fs/plugin_block_fs.c
index c1b4ad7c8..9b73f2497 100644
--- a/src/fs/plugin_block_fs.c
+++ b/src/fs/plugin_block_fs.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file block/plugin_block_fs.c
+ * @file fs/plugin_block_fs.c
  * @brief blocks used for file-sharing
  * @author Christian Grothoff
  */
diff --git a/src/hello/hello.c b/src/hello/hello.c
index b7f29f539..9c0c3d4ac 100644
--- a/src/hello/hello.c
+++ b/src/hello/hello.c
@@ -65,7 +65,7 @@ struct GNUNET_HELLO_Message
  * Copy the given address information into
  * the given buffer using the format of HELLOs.
  *
- * @param addess the address
+ * @param address the address
  * @param expiration expiration for the address
  * @param target where to copy the address
  * @param max maximum number of bytes to copy to target
diff --git a/src/transport/gnunet-transport-wlan-helper.c b/src/transport/gnunet-transport-wlan-helper.c
index 0e5d55b40..7be72482b 100644
--- a/src/transport/gnunet-transport-wlan-helper.c
+++ b/src/transport/gnunet-transport-wlan-helper.c
@@ -419,25 +419,48 @@ struct Hardware_Infos
 
 
 /**
- * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
- * @rtheader: pointer to the radiotap header we are walking through
- * @max_length: length of radiotap header in cpu byte ordering
- * @this_arg_index: IEEE80211_RADIOTAP_... index of current arg
- * @this_arg: pointer to current radiotap arg
- * @arg_index: internal next argument index
- * @arg: internal next argument pointer
- * @next_bitmap: internal pointer to next present uint32_t
- * @bitmap_shifter: internal shifter for curr uint32_t bitmap, b0 set == arg present
+ * struct ieee80211_radiotap_iterator - tracks walk through present radiotap args
  */
 struct ieee80211_radiotap_iterator
 {
+  /**
+   * pointer to the radiotap header we are walking through
+   */
   struct ieee80211_radiotap_header *rtheader;
+
+  /**
+   * length of radiotap header in cpu byte ordering
+   */
   int max_length;
+
+  /**
+   * IEEE80211_RADIOTAP_... index of current arg
+   */
   int this_arg_index;
+
+  /**
+   * pointer to current radiotap arg
+   */
   uint8_t *this_arg;
+
+  /**
+   * internal next argument index
+   */
   int arg_index;
+
+  /**
+   * internal next argument pointer
+   */
   uint8_t *arg;
+
+  /**
+   * internal pointer to next present uint32_t
+   */
   uint32_t *next_bitmap;
+
+  /**
+   * internal shifter for curr uint32_t bitmap, b0 set == arg present
+   */
   uint32_t bitmap_shifter;
 };
 
diff --git a/src/transport/plugin_transport_http_client.c b/src/transport/plugin_transport_http_client.c
index 96bd176f4..013b3f544 100644
--- a/src/transport/plugin_transport_http_client.c
+++ b/src/transport/plugin_transport_http_client.c
@@ -75,6 +75,7 @@ client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
  * Function setting up file descriptors and scheduling task to run
  *
  * @param  plugin plugin as closure
+ * @param now schedule task in 1ms, regardless of what curl may say
  * @return GNUNET_SYSERR for hard failure, GNUNET_OK for ok
  */
 static int
@@ -115,7 +116,7 @@ client_schedule (struct Plugin *plugin, int now)
   else
     timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, to);
   if (now == GNUNET_YES)
-    timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 1);
+    timeout = GNUNET_TIME_UNIT_MILLISECONDS;
 
   if (mret != CURLM_OK)
   {
@@ -358,7 +359,7 @@ client_wake_up (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 * @param stream pointer where to write data
 * @param size size of an individual element
 * @param nmemb count of elements that can be written to the buffer
-* @param ptr destination pointer, passed to the libcurl handle
+* @param cls destination pointer, passed to the libcurl handle
 * @return bytes read from stream
 */
 static size_t
@@ -413,7 +414,7 @@ client_receive (void *stream, size_t size, size_t nmemb, void *cls)
  * @param stream pointer where to write data
  * @param size size of an individual element
  * @param nmemb count of elements that can be written to the buffer
- * @param ptr source pointer, passed to the libcurl handle
+ * @param cls source pointer, passed to the libcurl handle
  * @return bytes written to stream, returning 0 will terminate connection!
  */
 static size_t
diff --git a/src/transport/plugin_transport_udp.c b/src/transport/plugin_transport_udp.c
index 87ee25005..a0d5072b8 100644
--- a/src/transport/plugin_transport_udp.c
+++ b/src/transport/plugin_transport_udp.c
@@ -461,6 +461,8 @@ inbound_session_iterator (void *cls, const GNUNET_HashCode * key, void *value)
  *
  * @param plugin the plugin
  * @param peer peer's identity
+ * @param addr address
+ * @param addrlen address length
  * @return NULL if we have no session
  */
 static struct Session *
diff --git a/src/transport/plugin_transport_wlan.c b/src/transport/plugin_transport_wlan.c
index 714f23f19..c7029a579 100644
--- a/src/transport/plugin_transport_wlan.c
+++ b/src/transport/plugin_transport_wlan.c
@@ -2377,7 +2377,7 @@ free_macendpoint (struct Plugin *plugin, struct MacEndpoint *endpoint)
  * function to free a session
  * @param plugin pointer to the plugin
  * @param queue pointer to the sessionqueue element to free
- * @param free_macendpoint if GNUNET_YES and mac endpoint would be empty, free mac endpoint
+ * @param do_free_macendpoint if GNUNET_YES and mac endpoint would be empty, free mac endpoint
  */
 static void
 free_session (struct Plugin *plugin, struct Sessionqueue *queue,
diff --git a/src/vpn/plugin_block_dns.c b/src/vpn/plugin_block_dns.c
index b33b3798a..34b054c8d 100644
--- a/src/vpn/plugin_block_dns.c
+++ b/src/vpn/plugin_block_dns.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file block/plugin_block_dns.c
+ * @file vpn/plugin_block_dns.c
  * @brief block plugin for storing .gnunet-bindings
  * @author Philipp Tölke
  */