[gnunet] 40/90: -DOC: Comment stripping pass through UTIL dnsstub, regex, speedup, and TUN libraries

[gnunet]

This is an automated email from the git hooks/post-receive script.

martin-schanzenbach pushed a commit to branch master
in repository gnunet.

commit 5f00aea2b3f7e5054e1467178ae62dccc8a5012d
Author: Willow Liquorice <willow@howhill.com>
AuthorDate: Sun Sep 4 03:22:05 2022 +0100

    -DOC: Comment stripping pass through UTIL dnsstub, regex, speedup, and TUN 
libraries
---
 src/util/dnsstub.c |  7 +------
 src/util/regex.c   | 42 ------------------------------------------
 src/util/speedup.c |  6 ------
 src/util/tun.c     | 39 ---------------------------------------
 4 files changed, 1 insertion(+), 93 deletions(-)

diff --git a/src/util/dnsstub.c b/src/util/dnsstub.c
index c2f2a441f..38f0eb004 100644
--- a/src/util/dnsstub.c
+++ b/src/util/dnsstub.c
@@ -387,7 +387,7 @@ do_dns_read (struct GNUNET_DNSSTUB_RequestSocket *rs,
 /**
  * Read a DNS response from the (unhindered) UDP-Socket
  *
- * @param cls socket to read from
+ * @param cls `struct GNUNET_DNSSTUB_RequestSocket` to read from
  */
 static void
 read_response (void *cls);
@@ -421,11 +421,6 @@ schedule_read (struct GNUNET_DNSSTUB_RequestSocket *rs)
 }
 
 
-/**
- * Read a DNS response from the (unhindered) UDP-Socket
- *
- * @param cls `struct GNUNET_DNSSTUB_RequestSocket` to read from
- */
 static void
 read_response (void *cls)
 {
diff --git a/src/util/regex.c b/src/util/regex.c
index fed325cd6..c2040a4b8 100644
--- a/src/util/regex.c
+++ b/src/util/regex.c
@@ -33,14 +33,6 @@
 #define DOT "(0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F)"
 
 
-/**
- * Create a regex in @a rxstr from the given @a ip and @a netmask.
- *
- * @param ip IPv4 representation.
- * @param port destination port
- * @param rxstr generated regex, must be at least #GNUNET_TUN_IPV4_REGEXLEN
- *              bytes long.
- */
 void
 GNUNET_TUN_ipv4toregexsearch (const struct in_addr *ip,
                               uint16_t port,
@@ -54,14 +46,6 @@ GNUNET_TUN_ipv4toregexsearch (const struct in_addr *ip,
 }
 
 
-/**
- * Create a regex in @a rxstr from the given @a ipv6 and @a prefixlen.
- *
- * @param ipv6 IPv6 representation.
- * @param port destination port
- * @param rxstr generated regex, must be at least #GNUNET_TUN_IPV6_REGEXLEN
- *              bytes long.
- */
 void
 GNUNET_TUN_ipv6toregexsearch (const struct in6_addr *ipv6,
                               uint16_t port,
@@ -694,15 +678,6 @@ ipv6_to_regex (const struct 
GNUNET_STRINGS_IPv6NetworkPolicy *v6)
 }
 
 
-/**
- * Convert an exit policy to a regular expression.  The exit policy
- * specifies a set of subnets this peer is willing to serve as an
- * exit for; the resulting regular expression will match the
- * IPv4 address strings as returned by #GNUNET_TUN_ipv4toregexsearch().
- *
- * @param policy exit policy specification
- * @return regular expression, NULL on error
- */
 char *
 GNUNET_TUN_ipv4policy2regex (const char *policy)
 {
@@ -746,15 +721,6 @@ GNUNET_TUN_ipv4policy2regex (const char *policy)
 }
 
 
-/**
- * Convert an exit policy to a regular expression.  The exit policy
- * specifies a set of subnets this peer is willing to serve as an
- * exit for; the resulting regular expression will match the
- * IPv6 address strings as returned by #GNUNET_TUN_ipv6toregexsearch().
- *
- * @param policy exit policy specification
- * @return regular expression, NULL on error
- */
 char *
 GNUNET_TUN_ipv6policy2regex (const char *policy)
 {
@@ -802,14 +768,6 @@ GNUNET_TUN_ipv6policy2regex (const char *policy)
 }
 
 
-/**
- * Hash the service name of a hosted service to the
- * hash code that is used to identify the service on
- * the network.
- *
- * @param service_name a string
- * @param hc corresponding hash
- */
 void
 GNUNET_TUN_service_name_to_hash (const char *service_name,
                                  struct GNUNET_HashCode *hc)
diff --git a/src/util/speedup.c b/src/util/speedup.c
index 3d9e82319..82a8746a9 100644
--- a/src/util/speedup.c
+++ b/src/util/speedup.c
@@ -55,12 +55,6 @@ do_speedup (void *cls)
 }
 
 
-/**
- * Start task that may speed up our system clock artificially
- *
- * @param cfg configuration to use
- * @return #GNUNET_OK on success, #GNUNET_SYSERR if the speedup was not 
configured
- */
 int
 GNUNET_SPEEDUP_start_ (const struct GNUNET_CONFIGURATION_Handle *cfg)
 {
diff --git a/src/util/tun.c b/src/util/tun.c
index d2b675c71..e22cf0be8 100644
--- a/src/util/tun.c
+++ b/src/util/tun.c
@@ -97,14 +97,6 @@ GNUNET_TUN_initialize_ipv6_header (struct 
GNUNET_TUN_IPv6Header *ip,
 }
 
 
-/**
- * Calculate IPv4 TCP checksum.
- *
- * @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
- */
 void
 GNUNET_TUN_calculate_tcp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
                                     struct GNUNET_TUN_TcpHeader *tcp,
@@ -135,14 +127,6 @@ GNUNET_TUN_calculate_tcp4_checksum (const struct 
GNUNET_TUN_IPv4Header *ip,
 }
 
 
-/**
- * Calculate IPv6 TCP checksum.
- *
- * @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
- */
 void
 GNUNET_TUN_calculate_tcp6_checksum (const struct GNUNET_TUN_IPv6Header *ip,
                                     struct GNUNET_TUN_TcpHeader *tcp,
@@ -171,14 +155,6 @@ GNUNET_TUN_calculate_tcp6_checksum (const struct 
GNUNET_TUN_IPv6Header *ip,
 }
 
 
-/**
- * Calculate IPv4 UDP checksum.
- *
- * @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
- */
 void
 GNUNET_TUN_calculate_udp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
                                     struct GNUNET_TUN_UdpHeader *udp,
@@ -210,14 +186,6 @@ GNUNET_TUN_calculate_udp4_checksum (const struct 
GNUNET_TUN_IPv4Header *ip,
 }
 
 
-/**
- * Calculate IPv6 UDP checksum.
- *
- * @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
- */
 void
 GNUNET_TUN_calculate_udp6_checksum (const struct GNUNET_TUN_IPv6Header *ip,
                                     struct GNUNET_TUN_UdpHeader *udp,
@@ -249,13 +217,6 @@ GNUNET_TUN_calculate_udp6_checksum (const struct 
GNUNET_TUN_IPv6Header *ip,
 }
 
 
-/**
- * Calculate ICMP checksum.
- *
- * @param icmp IMCP header (initialized except for CRC)
- * @param payload the ICMP payload
- * @param payload_length number of bytes of ICMP payload
- */
 void
 GNUNET_TUN_calculate_icmp_checksum (struct GNUNET_TUN_IcmpHeader *icmp,
                                     const void *payload,

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.