diff mbox series

[06/90] connection: Document gateway configuration flags.

Message ID 20231206235056.322578-7-gerickson@nuovations.com (mailing list archive)
State Not Applicable, archived
Headers show
Series Add Gateway Low-priority Default Routes for Non-default Services | expand

Commit Message

Grant Erickson Dec. 6, 2023, 11:49 p.m. UTC 
From: Grant Erickson <erick205@umn.edu>

This adds documentation to the 'gateway_config_flags' enumeration.
---
 src/connection.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
diff mbox series

Patch

diff --git a/src/connection.c b/src/connection.c
index b13403c4a673..17d3805cd5fd 100644
--- a/src/connection.c
+++ b/src/connection.c
@@ -38,8 +38,18 @@ 
 #define GATEWAY_DATA_DBG(description, data) \
 	gateway_data_debug(__func__, description, data)
 
+/**
+ *  Flags governing the state and use of a gateway configuration.
+ */
 enum gateway_config_flags {
+	/**
+	 *	Indicates there are no gateway configuration flags asserted.
+	 */
 	CONNMAN_GATEWAY_CONFIG_FLAG_NONE = 0,
+
+	/**
+	 *	Indicates whether the gateway configuration is part of a VPN.
+	 */
 	CONNMAN_GATEWAY_CONFIG_FLAG_VPN	 = 1U << 0
 };
 
@@ -72,6 +82,10 @@  enum gateway_config_state {
 };
 
 struct gateway_config {
+	/**
+	 *	A 32-bit flag bitfield governing the state and use of the
+	 *	configuration. See #gateway_config_flags.
+	 */
 	uint32_t flags;
 
 	/**