[60/90] connection: Document 'gateway_config'.

Commit Message

Grant Erickson Dec. 6, 2023, 11:50 p.m. UTC

This adds documentation to the 'gateway_config' structure.
---
 src/connection.c | 11 +++++++++++
 1 file changed, 11 insertions(+)

Patch

diff --git a/src/connection.c b/src/connection.c
index 8d2ac801c330..04a336e0b619 100644
--- a/src/connection.c
+++ b/src/connection.c
@@ -200,6 +200,11 @@  struct gateway_config_ops {
 		const char *gateway);
 };
 
+/**
+ *	An IP configuration type-specific data structure used to maintain
+ *	gateway-specific configuration information about a gateway, or
+ *	default router, and, for VPNs, the VPN peer.
+ */
 struct gateway_config {
 	/**
 	 *	A 32-bit flag bitfield governing the state and use of the
@@ -224,6 +229,12 @@  struct gateway_config {
 	 *  set/clear/add/delete operations.
 	 */
 	const struct gateway_config_ops *ops;
+
+	/**
+	 *	A pointer to a mutable, dynamically-allocated null-terminated
+	 *	C string containing the text-formatted address of the gateway,
+	 *	or default router.
+	 */
 	char *gateway;
 
 	/* VPN extra data */