[5/5] gateway: Expand the @param documentation for 'yield_default_gateway{,_for_type}'.

Commit Message

Grant Erickson Dec. 20, 2023, 5:56 a.m. UTC

This expands on the @param documentation for the
'yield_default_gateway{,_for_type}' functions by being more clear
about the source of the parameters.
---
 src/gateway.c | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

Patch

diff --git a/src/gateway.c b/src/gateway.c
index 42a8da72642c..16c87f83b4d6 100644
--- a/src/gateway.c
+++ b/src/gateway.c
@@ -3102,9 +3102,11 @@  static int promote_default_gateway(struct gateway_data *data,
  *  existing gateway from the services-to-gateway data hash.
  *
  *  @param[in,out]  activated  A pointer to a mutable newly-activated
- *                             gateway.
+ *                             gateway from a Routing Netlink (rtnl)
+ *                             notification.
  *  @param[in,out]  existing   A pointer to a mutable existing
- *                             gateway.
+ *                             gateway from the services-to-gateway
+ *                             hash.
  *  @param[in]      type       The IP configuration type for which
  *                             gateway, or default router, is to be
  *                             yielded.
@@ -3200,9 +3202,11 @@  done:
  *  existing gateway from the services-to-gateway data hash.
  *
  *  @param[in,out]  activated  A pointer to a mutable newly-activated
- *                             gateway.
+ *                             gateway from a Routing Netlink (rtnl)
+ *                             notification.
  *  @param[in,out]  existing   A pointer to a mutable existing
- *                             gateway.
+ *                             gateway from the services-to-gateway
+ *                             hash.
  *
  *  @returns
  *    True if @a activated yielded the default gateway; otherwise,