From: Andre Noll <maan@tuebingen.mpg.de>
Date: Thu, 10 Mar 2022 22:19:56 +0000 (+0100)
Subject: net: Combine documentation of struct flowopts.
X-Git-Tag: v0.7.2~20^2~8
X-Git-Url: https://git.tuebingen.mpg.de/?a=commitdiff_plain;h=b16ad193bad91e48cdfb9da42ae8192bd129d7fb;p=paraslash.git

net: Combine documentation of struct flowopts.

It was documented both in net.h and net.c.
---

diff --git a/net.c b/net.c
index e01af24b..4dd37674 100644
--- a/net.c
+++ b/net.c
@@ -273,7 +273,12 @@ struct pre_conn_opt {
 	struct list_head node;		/**< FIFO, as sockopt order matters. */
 };
 
-/** FIFO list of pre-connection socket options to be set */
+/**
+ * List of pre-connection socket options to be set.
+ *
+ * This list contains transport-layer independent encapsulation of socket
+ * options that need to be registered prior to setting up a connection.
+ */
 struct flowopts {
 	struct list_head sockopts;
 };
diff --git a/net.h b/net.h
index 0553a54a..9c06dd48 100644
--- a/net.h
+++ b/net.h
@@ -51,10 +51,7 @@
 /** The maximum length of the host component in an URL. */
 #define MAX_HOSTLEN 256
 
-/**
- * Flowopts: Transport-layer independent encapsulation of socket options
- *           that need to be registered prior to setting up a connection.
- */
+/* Opaque, only known to net.c. */
 struct flowopts;
 
 struct flowopts *flowopt_new(void);