diff mbox series

[08/90] connection: Document 'gateway_config_type'.

Message ID 20231206235056.322578-9-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_type' enumeration.
---
 src/connection.c | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
diff mbox series

Patch

diff --git a/src/connection.c b/src/connection.c
index bcecd886b85b..1f5997786c13 100644
--- a/src/connection.c
+++ b/src/connection.c
@@ -81,8 +81,20 @@  enum gateway_config_state {
 	CONNMAN_GATEWAY_CONFIG_STATE_ACTIVE	  = 1
 };
 
+/**
+ *	Indicates the current type or use of the gateway configuration.
+ */
 enum gateway_config_type {
+	/**
+	 *	Indicates the gateway, or default router, is not used for any
+	 *	route.
+	 */
 	CONNMAN_GATEWAY_CONFIG_TYPE_NONE				  = 0,
+
+	/**
+	 *	Indicates the gateway, or default router, is a high-priority
+	 *	(that is, metric 0) default route.
+	 */
 	CONNMAN_GATEWAY_CONFIG_TYPE_HIGH_PRIORITY_DEFAULT = 1
 };
 
@@ -98,6 +110,11 @@  struct gateway_config {
 	 *	#gateway_config_state.
 	 */
 	enum gateway_config_state state;
+
+	/**
+	 *	Indicates the current type or use of the gateway configuration.
+	 *	See #gateway_config_type.
+	 */
 	enum gateway_config_type type;
 	char *gateway;