[64/90] connection: Update 'find_any_active_gateway_data' documentation.

Commit Message

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

This updates documentation to the 'find_any_active_gateway_data'
function now that the module supports both high- and low-priority
default gateways and their routes.
---
 src/connection.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Patch

diff --git a/src/connection.c b/src/connection.c
index 053164c36297..7bfbefb2cfda 100644
--- a/src/connection.c
+++ b/src/connection.c
@@ -971,13 +971,13 @@  static struct gateway_data *find_any_active_gateway_data(void)
  *    default service.
  *
  *  This attempts to find the gateway, or default router, data
- *  associated with default network service (that is, has the default
- *  route).
+ *  associated with default network service (that is, has the
+ *  high-priority default route).
  *
  *  @returns
  *    A pointer to the gateway, or default router, data associated
- *    with the default network service (that is, has the default
- *    route) on success; otherwise, null.
+ *    with the default network service (that is, has the high-priority
+ *    default route) on success; otherwise, null.
  *
  *  @sa find_any_active_gateway_data
  *  @sa find_gateway_data