[02/90] connection: Document 'find_any_active_gateway_data'.

Commit Message

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

From: Grant Erickson <[e-mail]>

This adds documentation to the 'find_any_active_gateway_data'
function.
---
 src/connection.c | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Patch

diff --git a/src/connection.c b/src/connection.c
index f0da0c3c442c..6be39a773df1 100644
--- a/src/connection.c
+++ b/src/connection.c
@@ -352,6 +352,21 @@  static struct gateway_data *find_gateway_data(
 	return NULL;
 }
 
+/**
+ *  @brief
+ *    Find the first, or any, gateway data marked active.
+ *
+ *  This attempts to find the first, or any, gateway data marked
+ *  active.
+ *
+ *  @returns
+ *    A pointer to the first, or any, gateway data marked active on
+ *    success; otherwise, null.
+ *
+ *  @sa find_default_gateway_data
+ *  @sa find_gateway_data
+ *
+ */
 static struct gateway_data *find_any_active_gateway_data(void)
 {
 	GHashTableIter iter;