From: Christian Grothoff <christian@grothoff.org>
Date: Wed, 25 Jan 2012 16:42:00 +0000 (+0000)
Subject: -doxygen fixes
X-Git-Tag: initial-import-from-subversion-38251~15107
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=6f8eede98c272b7312ff0e08b182f0a39b2846b9;p=oweals%2Fgnunet.git

-doxygen fixes
---

diff --git a/src/dns/dns_api.c b/src/dns/dns_api.c
index dfce0af1b..a280265da 100644
--- a/src/dns/dns_api.c
+++ b/src/dns/dns_api.c
@@ -19,7 +19,7 @@
  */
 
 /**
- * @file dns/dns_api_new.c
+ * @file dns/dns_api.c
  * @brief API to access the DNS service. 
  * @author Christian Grothoff
  */
diff --git a/src/dns/gnunet-dns-monitor.c b/src/dns/gnunet-dns-monitor.c
index 3c7f31985..82715aabc 100644
--- a/src/dns/gnunet-dns-monitor.c
+++ b/src/dns/gnunet-dns-monitor.c
@@ -119,9 +119,9 @@ display_query (const struct GNUNET_DNSPARSER_Query *query)
 
 
 /**
- * Output the given DNS query to stdout.
+ * Output the given DNS record to stdout.
  *
- * @param query query to display.
+ * @param record record to display.
  */
 static void
 display_record (const struct GNUNET_DNSPARSER_Record *record)
diff --git a/src/dns/gnunet-dns-redirector.c b/src/dns/gnunet-dns-redirector.c
index cea8f5be9..a45b89609 100644
--- a/src/dns/gnunet-dns-redirector.c
+++ b/src/dns/gnunet-dns-redirector.c
@@ -56,9 +56,9 @@ static int verbosity;
 
 
 /**
- * Output the given DNS query to stdout.
+ * Modify the given DNS record.
  *
- * @param query query to display.
+ * @param record record to modify
  */
 static void
 modify_record (const struct GNUNET_DNSPARSER_Record *record)
diff --git a/src/dns/gnunet-service-dns.c b/src/dns/gnunet-service-dns.c
index 6370e95a6..17f60749e 100644
--- a/src/dns/gnunet-service-dns.c
+++ b/src/dns/gnunet-service-dns.c
@@ -1373,7 +1373,7 @@ receive_dns_request (void *cls GNUNET_UNUSED, struct GNUNET_MESH_Tunnel *tunnel,
  * @param cls closure
  * @param tunnel new handle to the tunnel
  * @param initiator peer that started the tunnel
- * @param atsi performance information for the tunnel
+ * @param ats performance information for the tunnel
  * @return initial tunnel context for the tunnel
  */
 static void *
diff --git a/src/dns/plugin_block_dns.c b/src/dns/plugin_block_dns.c
index 34b054c8d..96a4dc04e 100644
--- a/src/dns/plugin_block_dns.c
+++ b/src/dns/plugin_block_dns.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file vpn/plugin_block_dns.c
+ * @file dns/plugin_block_dns.c
  * @brief block plugin for storing .gnunet-bindings
  * @author Philipp Tölke
  */
diff --git a/src/exit/gnunet-daemon-exit.c b/src/exit/gnunet-daemon-exit.c
index 61c719e5d..dc9991422 100644
--- a/src/exit/gnunet-daemon-exit.c
+++ b/src/exit/gnunet-daemon-exit.c
@@ -1263,6 +1263,7 @@ setup_state_record (struct TunnelState *state)
  *                TCP header, depending on protocol)
  * @param payload_length number of bytes in 'payload'
  * @param protocol IPPROTO_UDP or IPPROTO_TCP
+ * @param tcp_header skeleton of the TCP header, NULL for UDP
  * @param src_address source address to use (IP and port)
  * @param dst_address destination address to use (IP and port)
  * @param pkt6 where to write the assembled packet; must
@@ -1439,7 +1440,7 @@ prepare_ipv6_packet (const void *payload, size_t payload_length,
  *
  * @param destination_address IP and port to use for the TCP packet's destination
  * @param source_address IP and port to use for the TCP packet's source
- * @param tcp header template to use
+ * @param tcp_header header template to use
  * @param payload payload of the TCP packet
  * @param payload_length number of bytes in 'payload'
  */
@@ -1541,7 +1542,7 @@ send_tcp_packet_via_tun (const struct SocketAddress *destination_address,
  *         GNUNET_SYSERR to close it (signal serious error)
  */
 static int
-receive_tcp_service (void *unused GNUNET_UNUSED, struct GNUNET_MESH_Tunnel *tunnel,
+receive_tcp_service (void *cls GNUNET_UNUSED, struct GNUNET_MESH_Tunnel *tunnel,
                      void **tunnel_ctx GNUNET_UNUSED,
                      const struct GNUNET_PeerIdentity *sender GNUNET_UNUSED,
                      const struct GNUNET_MessageHeader *message,
diff --git a/src/fs/fs_dirmetascan.c b/src/fs/fs_dirmetascan.c
index 0459ca009..8700a69f1 100644
--- a/src/fs/fs_dirmetascan.c
+++ b/src/fs/fs_dirmetascan.c
@@ -341,7 +341,7 @@ should_stop (struct AddDirContext *adc)
 /**
  * Write progress message.
  * Format is:
- * <reason><filename length><filename><directory flag>
+ * "reason", "filename length", "filename", "directory flag"
  * If filename is NULL, filename is not written, and its length
  * is written as 0, and nothing else is written. It signals the initiator
  * thread that the scanner is finished, and that it can now join its thread.
@@ -540,7 +540,7 @@ make_item (struct GNUNET_FS_ShareTreeItem *parent)
 /**
  * Extract metadata from a file and add it to the share tree
  *
- * @param adc context to modify
+ * @param ads context to modify
  * @param filename name of the file to process
  */
 static void
diff --git a/src/fs/gnunet-service-fs_cp.c b/src/fs/gnunet-service-fs_cp.c
index ba6a8ce87..86986b899 100644
--- a/src/fs/gnunet-service-fs_cp.c
+++ b/src/fs/gnunet-service-fs_cp.c
@@ -875,6 +875,7 @@ get_randomized_delay ()
  * @param pr handle to the original pending request
  * @param reply_anonymity_level anonymity level for the reply, UINT32_MAX for "unknown"
  * @param expiration when does 'data' expire?
+ * @param last_transmission when did we last transmit a request for this block
  * @param type type of the block
  * @param data response data, NULL on request expiration
  * @param data_len number of bytes in data
diff --git a/src/fs/gnunet-service-fs_pe.c b/src/fs/gnunet-service-fs_pe.c
index 78769fa82..f1d87db01 100644
--- a/src/fs/gnunet-service-fs_pe.c
+++ b/src/fs/gnunet-service-fs_pe.c
@@ -701,12 +701,12 @@ GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
 
 /**
  * Get the last transmission attempt time for the request plan list
- * referenced by @rpr_head, that was sent to @sender
+ * referenced by 'rpr_head', that was sent to 'sender'
  *
  * @param rpr_head request plan reference list to check.
  * @param sender the peer that we've sent the request to.
  * @param result the timestamp to fill.
- * @return GNUNET_YES if @result was changed, GNUNET_NO otherwise.
+ * @return GNUNET_YES if 'result' was changed, GNUNET_NO otherwise.
  */
 int
 GSF_request_plan_reference_get_last_transmission_ (
diff --git a/src/fs/gnunet-service-fs_pe.h b/src/fs/gnunet-service-fs_pe.h
index da20a7d7b..3a18715ca 100644
--- a/src/fs/gnunet-service-fs_pe.h
+++ b/src/fs/gnunet-service-fs_pe.h
@@ -60,12 +60,12 @@ GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr);
 
 /**
  * Get the last transmission attempt time for the request plan list
- * referenced by @rpr_head, that was sent to @sender
+ * referenced by 'rpr_head', that was sent to 'sender'
  *
  * @param rpr_head request plan reference list to check.
  * @param sender the peer that we've sent the request to.
  * @param result the timestamp to fill.
- * @return GNUNET_YES if @result was changed, GNUNET_NO otherwise.
+ * @return GNUNET_YES if 'result' was changed, GNUNET_NO otherwise.
  */
 int
 GSF_request_plan_reference_get_last_transmission_ (
diff --git a/src/include/gnunet_common.h b/src/include/gnunet_common.h
index 7c587a782..04847ee5b 100644
--- a/src/include/gnunet_common.h
+++ b/src/include/gnunet_common.h
@@ -507,7 +507,7 @@ GNUNET_htonll (uint64_t n);
  * @return the same value in host byte order
  */
 double 
-GNUNET_hton_double (double in);
+GNUNET_hton_double (double d);
 
 /**
  * Convert double to host-byte-order
@@ -515,7 +515,7 @@ GNUNET_hton_double (double in);
  * @return the same value in host byte order
  */
 double 
-GNUNET_ntoh_double (double in);
+GNUNET_ntoh_double (double d);
 
 /* ************************* allocation functions ****************** */
 
diff --git a/src/include/gnunet_disk_lib.h b/src/include/gnunet_disk_lib.h
index 46dd7c4c4..25f972b5b 100644
--- a/src/include/gnunet_disk_lib.h
+++ b/src/include/gnunet_disk_lib.h
@@ -389,7 +389,9 @@ GNUNET_DISK_file_handle_size (struct GNUNET_DISK_FileHandle *fh,
 
 /**
  * Creates an interprocess channel
- * @param blocking creates an asynchronous pipe if set to GNUNET_NO
+ *
+ * @param blocking_read creates an asynchronous pipe for reading if set to GNUNET_NO
+ * @param blocking_write creates an asynchronous pipe for writing if set to GNUNET_NO
  * @param inherit_read 1 to make read handle inheritable, 0 otherwise (NT only)
  * @param inherit_write 1 to make write handle inheritable, 0 otherwise (NT only)
  * @return handle to the new pipe, NULL on error
diff --git a/src/include/gnunet_dns_service.h b/src/include/gnunet_dns_service.h
index 3517a4609..a822b06ae 100644
--- a/src/include/gnunet_dns_service.h
+++ b/src/include/gnunet_dns_service.h
@@ -19,7 +19,7 @@
  */
 
 /**
- * @file include/gnunet_dns_service-new.h
+ * @file include/gnunet_dns_service.h
  * @brief API to access the DNS service. 
  * @author Christian Grothoff
  */
diff --git a/src/include/gnunet_dnsparser_lib.h b/src/include/gnunet_dnsparser_lib.h
index a1fb920a7..0c310ba00 100644
--- a/src/include/gnunet_dnsparser_lib.h
+++ b/src/include/gnunet_dnsparser_lib.h
@@ -19,7 +19,7 @@
  */
 
 /**
- * @file include/gnunet_dnsparse_lib.h
+ * @file include/gnunet_dnsparser_lib.h
  * @brief API for helper library to parse DNS packets. 
  * @author Philipp Toelke
  * @author Christian Grothoff
diff --git a/src/include/gnunet_tun_lib.h b/src/include/gnunet_tun_lib.h
index 9cc58e85c..b02c6c02e 100644
--- a/src/include/gnunet_tun_lib.h
+++ b/src/include/gnunet_tun_lib.h
@@ -241,7 +241,7 @@ GNUNET_TUN_initialize_ipv6_header (struct GNUNET_TUN_IPv6Header *ip,
 /**
  * Calculate IPv4 TCP checksum.
  *
- * @param ipv4 header fully initialized
+ * @param ip ipv4 header fully initialized
  * @param tcp TCP header (initialized except for CRC)
  * @param payload the TCP payload
  * @param payload_length number of bytes of TCP payload
@@ -255,7 +255,7 @@ GNUNET_TUN_calculate_tcp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
 /**
  * Calculate IPv6 TCP checksum.
  *
- * @param ipv6 header fully initialized
+ * @param ip ipv6 header fully initialized
  * @param tcp TCP header (initialized except for CRC)
  * @param payload the TCP payload
  * @param payload_length number of bytes of TCP payload
@@ -269,7 +269,7 @@ GNUNET_TUN_calculate_tcp6_checksum (const struct GNUNET_TUN_IPv6Header *ip,
 /**
  * Calculate IPv4 UDP checksum.
  *
- * @param ipv4 header fully initialized
+ * @param ip ipv4 header fully initialized
  * @param udp UDP header (initialized except for CRC)
  * @param payload the UDP payload
  * @param payload_length number of bytes of UDP payload
@@ -284,7 +284,7 @@ GNUNET_TUN_calculate_udp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
 /**
  * Calculate IPv6 UDP checksum.
  *
- * @param ipv6 header fully initialized
+ * @param ip ipv6 header fully initialized
  * @param udp UDP header (initialized except for CRC)
  * @param payload the UDP payload
  * @param payload_length number of bytes of UDP payload
diff --git a/src/testing/gnunet-testing.c b/src/testing/gnunet-testing.c
index 1c518fef9..f5d7ab36c 100644
--- a/src/testing/gnunet-testing.c
+++ b/src/testing/gnunet-testing.c
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file template/gnunet-testing.c
+ * @file testing/gnunet-testing.c
  * @brief tool to use testing functionality from cmd line
  * @author Christian Grothoff
  */
diff --git a/src/tun/tun.c b/src/tun/tun.c
index 4c2ddf07a..12781798c 100644
--- a/src/tun/tun.c
+++ b/src/tun/tun.c
@@ -99,7 +99,7 @@ GNUNET_TUN_initialize_ipv6_header (struct GNUNET_TUN_IPv6Header *ip,
 /**
  * Calculate IPv4 TCP checksum.
  *
- * @param ipv4 header fully initialized
+ * @param ip ipv4 header fully initialized
  * @param tcp TCP header (initialized except for CRC)
  * @param payload the TCP payload
  * @param payload_length number of bytes of TCP payload
@@ -132,7 +132,7 @@ GNUNET_TUN_calculate_tcp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
 /**
  * Calculate IPv6 TCP checksum.
  *
- * @param ipv6 header fully initialized
+ * @param ip ipv6 header fully initialized
  * @param tcp header (initialized except for CRC)
  * @param payload the TCP payload
  * @param payload_length number of bytes of TCP payload
@@ -165,7 +165,7 @@ GNUNET_TUN_calculate_tcp6_checksum (const struct GNUNET_TUN_IPv6Header *ip,
 /**
  * Calculate IPv4 UDP checksum.
  *
- * @param ipv4 header fully initialized
+ * @param ip ipv4 header fully initialized
  * @param udp UDP header (initialized except for CRC)
  * @param payload the UDP payload
  * @param payload_length number of bytes of UDP payload
@@ -208,7 +208,7 @@ GNUNET_TUN_calculate_udp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
 /**
  * Calculate IPv6 UDP checksum.
  *
- * @param ipv6 header fully initialized
+ * @param ip ipv6 header fully initialized
  * @param udp UDP header (initialized except for CRC)
  * @param payload the UDP payload
  * @param payload_length number of bytes of UDP payload
diff --git a/src/util/common_endian.c b/src/util/common_endian.c
index 1a2ddd9c1..56aa7b0c4 100644
--- a/src/util/common_endian.c
+++ b/src/util/common_endian.c
@@ -52,7 +52,7 @@ GNUNET_htonll (uint64_t n)
 
 /**
  * Convert double to network-byte-order.
- * @param n the value in network byte order
+ * @param d the value in network byte order
  * @return the same value in host byte order
  */
 double 
diff --git a/src/util/disk.c b/src/util/disk.c
index 7ce4f5808..a044482f1 100644
--- a/src/util/disk.c
+++ b/src/util/disk.c
@@ -1252,7 +1252,7 @@ GNUNET_DISK_directory_iterator_next (struct GNUNET_DISK_DirectoryIterator *iter,
  * @param dirName the name of the directory
  * @param callback the method to call for each file
  * @param callback_cls closure for callback
- * @return GNUNET_YES if directory is not empty and @callback
+ * @return GNUNET_YES if directory is not empty and 'callback'
  *         will be called later, GNUNET_NO otherwise, GNUNET_SYSERR on error.
  */
 int
@@ -2113,10 +2113,10 @@ create_selectable_pipe (PHANDLE read_pipe_ptr, PHANDLE write_pipe_ptr,
 /**
  * Creates an interprocess channel
  *
- * @param blocking creates an asynchronous pipe if set to GNUNET_NO
+ * @param blocking_read creates an asynchronous pipe for reading if set to GNUNET_NO
+ * @param blocking_write creates an asynchronous pipe for writing if set to GNUNET_NO
  * @param inherit_read inherit the parent processes stdin (only for windows)
  * @param inherit_write inherit the parent processes stdout (only for windows)
- *
  * @return handle to the new pipe, NULL on error
  */
 struct GNUNET_DISK_PipeHandle *
diff --git a/src/util/helper.c b/src/util/helper.c
index 6ebc3a444..c7e059237 100644
--- a/src/util/helper.c
+++ b/src/util/helper.c
@@ -216,14 +216,14 @@ restart_task (void *cls,
  */
 static void
 helper_read (void *cls,
-	     const struct GNUNET_SCHEDULER_TaskContext *tsdkctx)
+	     const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct GNUNET_HELPER_Handle *h = cls;
   char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE];
   ssize_t t;
 
   h->read_task = GNUNET_SCHEDULER_NO_TASK;
-  if (0 != (tsdkctx->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
+  if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
   {
     /* try again */
     h->read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
@@ -404,7 +404,7 @@ GNUNET_HELPER_stop (struct GNUNET_HELPER_Handle *h)
  */
 static void
 helper_write (void *cls,
-	     const struct GNUNET_SCHEDULER_TaskContext *tsdkctx)
+	     const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct GNUNET_HELPER_Handle *h = cls;
   struct HelperMessageQueueEntry *qe;
@@ -412,7 +412,7 @@ helper_write (void *cls,
   ssize_t t;
 
   h->write_task = GNUNET_SCHEDULER_NO_TASK;
-  if (0 != (tsdkctx->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
+  if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
   {
     /* try again */
     h->write_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
diff --git a/src/vpn/gnunet-service-vpn.c b/src/vpn/gnunet-service-vpn.c
index 4db343f6a..8f4d11bc9 100644
--- a/src/vpn/gnunet-service-vpn.c
+++ b/src/vpn/gnunet-service-vpn.c
@@ -565,7 +565,7 @@ free_tunnel_state (struct TunnelState *ts)
  * Destroy the mesh tunnel.
  *
  * @param cls the 'struct TunnelState' with the tunnel to destroy
- * @param ts schedule context
+ * @param tc scheduler context
  */
 static void
 destroy_tunnel_task (void *cls,
@@ -751,6 +751,7 @@ send_to_tunnel (struct TunnelMessageQueueEntry *tnq,
  *
  * @param de destination entry for which we need to setup a tunnel
  * @param client client to notify on successful tunnel setup, or NULL for none
+ * @param client_af address family of the address returned to the client
  * @param request_id request ID to send in client notification (unused if client is NULL)
  * @return tunnel state of the tunnel that was created
  */