diff options
| author | Grant Erickson <gerickson@nuovations.com> | 2023-12-19 21:56:13 -0800 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2023-12-23 13:14:31 +0100 |
| commit | e635a35993a00f7972ce3fce85a94af2903a12ec (patch) | |
| tree | 4a0dae451780237033d29db95d87b27a1e1842fc | |
| parent | e4bf3db0aa426a876afda47572fd66fe9f2d3489 (diff) | |
| download | connman-e635a35993a00f7972ce3fce85a94af2903a12ec.tar.gz | |
gateway: Expand the @param documentation for 'yield_default_gateway{,_for_type}'.
This expands on the @param documentation for the
'yield_default_gateway{,_for_type}' functions by being more clear
about the source of the parameters.
| -rw-r--r-- | src/gateway.c | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/src/gateway.c b/src/gateway.c index 42a8da726..16c87f83b 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, |