[v2,31/60] service: Document 'online_check_counter_reset'.

Commit Message

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

This adds documentation to the 'online_check_counter_reset' function.
---
 src/service.c | 7 +++++++
 1 file changed, 7 insertions(+)

Patch

diff --git a/src/service.c b/src/service.c
index 6e34b4c8ef34..8a1d09f1a4fd 100644
--- a/src/service.c
+++ b/src/service.c
@@ -2250,6 +2250,13 @@  static void online_check_failures_threshold_was_met_clear(
 	online_check_failures_threshold_was_met_set_value(service, false);
 }
 
+/**
+ *  Reset the specified counter to zero (0).
+ *
+ *  @param[in,out]  counter  A pointer to the counter to reset by
+ *                           setting it to zero (0).
+ *
+ */
 static inline void online_check_counter_reset(
 			unsigned int *counter)
 {