service: Document the 'current_default' global.

Commit Message

Grant Erickson Nov. 17, 2023, 9:49 p.m. UTC

This documents the 'current_default' global and includes "see also"
references to related functions.
---
 src/service.c | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

Marcel Holtmann Nov. 23, 2023, 11:24 a.m. UTC | #1

Hi Grant,

> This documents the 'current_default' global and includes "see also"
> references to related functions.
> ---
> src/service.c | 9 +++++++++
> 1 file changed, 9 insertions(+)

patch has been applied.

Regards

Marcel

Patch

diff --git a/src/service.c b/src/service.c
index 81a1bebdc14b..8562be99f6bf 100644
--- a/src/service.c
+++ b/src/service.c
@@ -55,6 +55,15 @@  static GHashTable *passphrase_requested = NULL;
 static GSList *counter_list = NULL;
 static unsigned int autoconnect_id = 0;
 static unsigned int vpn_autoconnect_id = 0;
+/**
+ *  A weak reference to the current default service (that is, has the
+ *  default route) used to compare against another service when the
+ *  default service has potentially changed.
+ *
+ *  @sa connman_service_get_default
+ *  @sa connman_service_is_default
+ *
+ */
 static struct connman_service *current_default = NULL;
 static bool services_dirty = false;
 static bool enable_online_to_ready_transition = false;