[GNUnet-SVN] r19397 - in gnunet/src: dns exit fs include testing tun util vpn

[gnunet]

Author: grothoff
Date: 2012-01-25 17:42:00 +0100 (Wed, 25 Jan 2012)
New Revision: 19397

Modified:
   gnunet/src/dns/dns_api.c
   gnunet/src/dns/gnunet-dns-monitor.c
   gnunet/src/dns/gnunet-dns-redirector.c
   gnunet/src/dns/gnunet-service-dns.c
   gnunet/src/dns/plugin_block_dns.c
   gnunet/src/exit/gnunet-daemon-exit.c
   gnunet/src/fs/fs_dirmetascan.c
   gnunet/src/fs/gnunet-service-fs_cp.c
   gnunet/src/fs/gnunet-service-fs_pe.c
   gnunet/src/fs/gnunet-service-fs_pe.h
   gnunet/src/include/gnunet_common.h
   gnunet/src/include/gnunet_disk_lib.h
   gnunet/src/include/gnunet_dns_service.h
   gnunet/src/include/gnunet_dnsparser_lib.h
   gnunet/src/include/gnunet_tun_lib.h
   gnunet/src/testing/gnunet-testing.c
   gnunet/src/tun/tun.c
   gnunet/src/util/common_endian.c
   gnunet/src/util/disk.c
   gnunet/src/util/helper.c
   gnunet/src/vpn/gnunet-service-vpn.c
Log:
-doxygen fixes

Modified: gnunet/src/dns/dns_api.c
===================================================================
--- gnunet/src/dns/dns_api.c    2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/dns/dns_api.c    2012-01-25 16:42:00 UTC (rev 19397)
@@ -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
  */

Modified: gnunet/src/dns/gnunet-dns-monitor.c
===================================================================
--- gnunet/src/dns/gnunet-dns-monitor.c 2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/dns/gnunet-dns-monitor.c 2012-01-25 16:42:00 UTC (rev 19397)
@@ -119,9 +119,9 @@
 
 
 /**
- * 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)

Modified: gnunet/src/dns/gnunet-dns-redirector.c
===================================================================
--- gnunet/src/dns/gnunet-dns-redirector.c      2012-01-25 16:41:38 UTC (rev 
19396)
+++ gnunet/src/dns/gnunet-dns-redirector.c      2012-01-25 16:42:00 UTC (rev 
19397)
@@ -56,9 +56,9 @@
 
 
 /**
- * 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)

Modified: gnunet/src/dns/gnunet-service-dns.c
===================================================================
--- gnunet/src/dns/gnunet-service-dns.c 2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/dns/gnunet-service-dns.c 2012-01-25 16:42:00 UTC (rev 19397)
@@ -1373,7 +1373,7 @@
  * @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 *

Modified: gnunet/src/dns/plugin_block_dns.c
===================================================================
--- gnunet/src/dns/plugin_block_dns.c   2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/dns/plugin_block_dns.c   2012-01-25 16:42:00 UTC (rev 19397)
@@ -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
  */

Modified: gnunet/src/exit/gnunet-daemon-exit.c
===================================================================
--- gnunet/src/exit/gnunet-daemon-exit.c        2012-01-25 16:41:38 UTC (rev 
19396)
+++ gnunet/src/exit/gnunet-daemon-exit.c        2012-01-25 16:42:00 UTC (rev 
19397)
@@ -1263,6 +1263,7 @@
  *                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 @@
  *
  * @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 @@
  *         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,

Modified: gnunet/src/fs/fs_dirmetascan.c
===================================================================
--- gnunet/src/fs/fs_dirmetascan.c      2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/fs/fs_dirmetascan.c      2012-01-25 16:42:00 UTC (rev 19397)
@@ -341,7 +341,7 @@
 /**
  * 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 @@
 /**
  * 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

Modified: gnunet/src/fs/gnunet-service-fs_cp.c
===================================================================
--- gnunet/src/fs/gnunet-service-fs_cp.c        2012-01-25 16:41:38 UTC (rev 
19396)
+++ gnunet/src/fs/gnunet-service-fs_cp.c        2012-01-25 16:42:00 UTC (rev 
19397)
@@ -875,6 +875,7 @@
  * @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

Modified: gnunet/src/fs/gnunet-service-fs_pe.c
===================================================================
--- gnunet/src/fs/gnunet-service-fs_pe.c        2012-01-25 16:41:38 UTC (rev 
19396)
+++ gnunet/src/fs/gnunet-service-fs_pe.c        2012-01-25 16:42:00 UTC (rev 
19397)
@@ -701,12 +701,12 @@
 
 /**
  * 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_ (

Modified: gnunet/src/fs/gnunet-service-fs_pe.h
===================================================================
--- gnunet/src/fs/gnunet-service-fs_pe.h        2012-01-25 16:41:38 UTC (rev 
19396)
+++ gnunet/src/fs/gnunet-service-fs_pe.h        2012-01-25 16:42:00 UTC (rev 
19397)
@@ -60,12 +60,12 @@
 
 /**
  * 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_ (

Modified: gnunet/src/include/gnunet_common.h
===================================================================
--- gnunet/src/include/gnunet_common.h  2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/include/gnunet_common.h  2012-01-25 16:42:00 UTC (rev 19397)
@@ -507,7 +507,7 @@
  * @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 @@
  * @return the same value in host byte order
  */
 double 
-GNUNET_ntoh_double (double in);
+GNUNET_ntoh_double (double d);
 
 /* ************************* allocation functions ****************** */
 

Modified: gnunet/src/include/gnunet_disk_lib.h
===================================================================
--- gnunet/src/include/gnunet_disk_lib.h        2012-01-25 16:41:38 UTC (rev 
19396)
+++ gnunet/src/include/gnunet_disk_lib.h        2012-01-25 16:42:00 UTC (rev 
19397)
@@ -389,7 +389,9 @@
 
 /**
  * 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

Modified: gnunet/src/include/gnunet_dns_service.h
===================================================================
--- gnunet/src/include/gnunet_dns_service.h     2012-01-25 16:41:38 UTC (rev 
19396)
+++ gnunet/src/include/gnunet_dns_service.h     2012-01-25 16:42:00 UTC (rev 
19397)
@@ -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
  */

Modified: gnunet/src/include/gnunet_dnsparser_lib.h
===================================================================
--- gnunet/src/include/gnunet_dnsparser_lib.h   2012-01-25 16:41:38 UTC (rev 
19396)
+++ gnunet/src/include/gnunet_dnsparser_lib.h   2012-01-25 16:42:00 UTC (rev 
19397)
@@ -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

Modified: gnunet/src/include/gnunet_tun_lib.h
===================================================================
--- gnunet/src/include/gnunet_tun_lib.h 2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/include/gnunet_tun_lib.h 2012-01-25 16:42:00 UTC (rev 19397)
@@ -241,7 +241,7 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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

Modified: gnunet/src/testing/gnunet-testing.c
===================================================================
--- gnunet/src/testing/gnunet-testing.c 2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/testing/gnunet-testing.c 2012-01-25 16:42:00 UTC (rev 19397)
@@ -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
  */

Modified: gnunet/src/tun/tun.c
===================================================================
--- gnunet/src/tun/tun.c        2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/tun/tun.c        2012-01-25 16:42:00 UTC (rev 19397)
@@ -99,7 +99,7 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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

Modified: gnunet/src/util/common_endian.c
===================================================================
--- gnunet/src/util/common_endian.c     2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/util/common_endian.c     2012-01-25 16:42:00 UTC (rev 19397)
@@ -52,7 +52,7 @@
 
 /**
  * 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 

Modified: gnunet/src/util/disk.c
===================================================================
--- gnunet/src/util/disk.c      2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/util/disk.c      2012-01-25 16:42:00 UTC (rev 19397)
@@ -1252,7 +1252,7 @@
  * @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 @@
 /**
  * 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 *

Modified: gnunet/src/util/helper.c
===================================================================
--- gnunet/src/util/helper.c    2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/util/helper.c    2012-01-25 16:42:00 UTC (rev 19397)
@@ -216,14 +216,14 @@
  */
 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 @@
  */
 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 @@
   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,

Modified: gnunet/src/vpn/gnunet-service-vpn.c
===================================================================
--- gnunet/src/vpn/gnunet-service-vpn.c 2012-01-25 16:41:38 UTC (rev 19396)
+++ gnunet/src/vpn/gnunet-service-vpn.c 2012-01-25 16:42:00 UTC (rev 19397)
@@ -565,7 +565,7 @@
  * 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 @@
  *
  * @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
  */