diff mbox series

[22/90] connection: Document 'gateway_config_free'.

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

Patch

diff --git a/src/connection.c b/src/connection.c
index 5b0f18627f40..f07974aee938 100644
--- a/src/connection.c
+++ b/src/connection.c
@@ -1698,6 +1698,17 @@  static void connection_newgateway(int index, const char *gateway)
 	check_default_gateway(data);
 }
 
+/**
+ *  @brief
+ *    Deallocate gateway configuration resources.
+ *
+ *  This attempts to deallocate resources associated with the
+ *  specified gateway configuration.
+ *
+ *  @param[in,out]  config  A pointer to the mutable gateway
+ *                  configuration to deallocate.
+ *
+ */
 static void gateway_config_free(struct gateway_config *config)
 {
 	DBG("config %p", config);