[10/11] wispr: Document 'wispr_portal_context_route_ops'.

Commit Message

Grant Erickson Dec. 16, 2023, 6:12 a.m. UTC

This adds documentation to the 'wispr_portal_context_route_ops'
structure.
---
 src/wispr.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

Patch

diff --git a/src/wispr.c b/src/wispr.c
index 317146af8cb8..1af880118e14 100644
--- a/src/wispr.c
+++ b/src/wispr.c
@@ -75,6 +75,10 @@  struct wispr_route {
 	uint32_t metric;
 };
 
+/**
+ *  Gateway configuration function pointers for IP configuration
+ *  type-specific route set/clear/add/delete operations.
+ */
 struct wispr_portal_context_route_ops {
 	int (*add_host_route_with_metric)(int index,
 		const char *host,
@@ -90,7 +94,13 @@  struct connman_wispr_portal_context {
 	int refcount;
 	struct connman_service *service;
 	enum connman_ipconfig_type type;
+
+	/**
+	 *	A pointer to immutable function pointers for route
+	 *	set/clear/add/delete operations.
+	 */
 	const struct wispr_portal_context_route_ops *ops;
+
 	__connman_wispr_cb_t cb;
 	struct connman_wispr_portal *wispr_portal;