net: Combine documentation of struct flowopts.
authorAndre Noll <maan@tuebingen.mpg.de>
Thu, 10 Mar 2022 22:19:56 +0000 (23:19 +0100)
committerAndre Noll <maan@tuebingen.mpg.de>
Mon, 3 Oct 2022 20:53:49 +0000 (22:53 +0200)
It was documented both in net.h and net.c.

net.c
net.h

diff --git a/net.c b/net.c
index e01af24be27c49a00a60a61a98448bc3d82046f0..4dd376748313c4cd8e614da0744d734062bb5e80 100644 (file)
--- 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 0553a54a02b8a2eaee9640353d2eadf5a6b5640c..9c06dd489380e859492c75736fabb7f33e28e8ea 100644 (file)
--- a/net.h
+++ b/net.h
 /** 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);