[24/90] connection: Document 'mutate_default_gateway_ops'.

Commit Message

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

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

Patch

diff --git a/src/connection.c b/src/connection.c
index 0136754128d5..d78b3f0400a9 100644
--- a/src/connection.c
+++ b/src/connection.c
@@ -144,9 +144,43 @@  struct gateway_data {
 	bool default_checked;
 };
 
+/**
+ *	Function pointers to mutating (including, but not limited to,
+ *	adding/setting or clearing/deleting/removing routes) IPv4 and/or
+ *	IPv6 default gateways.
+ */
 struct mutate_default_gateway_ops {
+	/**
+	 *  An optional pointer to a function for mutating (including, but
+	 *  not limited to, adding/setting or clearing/deleting/removing
+	 *  routes) an IPv4 default gateway.
+	 *
+	 *  @param[in,out]  data    A pointer to the mutable IPv4 gateway
+	 *                          data to mutate.
+	 *  @param[in,out]  config  A pointer to the mutable IPv4 gateway
+	 *                          configuration to mutate.
+	 *
+	 *  @returns
+	 *    0 if successful; otherwise, < 0 on error.
+	 *
+	 */
 	int (*mutate_ipv4)(struct gateway_data *data,
 				struct gateway_config *config);
+
+	/**
+	 *  An optional pointer to a function for mutating (including, but
+	 *  not limited to, adding/setting or clearing/deleting/removing
+	 *  routes) an IPv6 default gateway.
+	 *
+	 *  @param[in,out]  data    A pointer to the mutable IPv6 gateway
+	 *                          data to mutate.
+	 *  @param[in,out]  config  A pointer to the mutable IPv6 gateway
+	 *                          configuration to mutate.
+	 *
+	 *  @returns
+	 *    0 if successful; otherwise, < 0 on error.
+	 *
+	 */
 	int (*mutate_ipv6)(struct gateway_data *data,
 				struct gateway_config *config);
 };