[v2,19/60] service: Document 'online_check_state' 'failures/successes' members.

Commit Message

Grant Erickson Dec. 21, 2023, 6:39 a.m. UTC

This documents the 'failures/successes' members of the
'online_check_state' structure.
---
 src/service.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

Patch

diff --git a/src/service.c b/src/service.c
index db1d45f61063..5f9dcab58092 100644
--- a/src/service.c
+++ b/src/service.c
@@ -109,7 +109,17 @@  struct online_check_state {
 	 *
 	 */
 	unsigned int interval;
+
+	/**
+	 *	The number of sustained, back-to-back "online" reachability
+	 *	check successes for "continuous" online check mode.
+	 */
 	unsigned int successes;
+
+	/**
+	 *	The number of sustained, back-to-back "online" reachability
+	 *	check failures for "continuous" online check mode.
+	 */
 	unsigned int failures;
 };