diff mbox series

[19/90] connection: Document 'gateway_data_config_get'.

Message ID 20231206235056.322578-20-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_data_config_get' function.
---
 src/connection.c | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
diff mbox series

Patch

diff --git a/src/connection.c b/src/connection.c
index e328a929b306..a89fec393960 100644
--- a/src/connection.c
+++ b/src/connection.c
@@ -394,6 +394,22 @@  static void gateway_data_debug(const char *function,
 	}
 }
 
+/**
+ *  @brief
+ *    Return the IP-specific gateway configuration for the specified
+ *    gateway data.
+ *
+ *  @param[in]  data  A pointer to the mutable gateway data for which
+ *                    the gateway configuration is to be returned,
+ *                    specific to @a type.
+ *  @param[in]  type  The IP configuration type for which the gateway
+ *                    configuration is to be returned.
+ *
+ *  @returns
+ *    The IP-specific gateway configuration for the specified gateway
+ *    data on success; otherwise, null.
+ *
+ */
 static struct gateway_config *gateway_data_config_get(struct gateway_data *data,
 				enum connman_ipconfig_type type)
 {