From 85595909d57159907df4789320b857e5a2b946cf Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Thu, 5 Feb 2009 22:38:52 +0100 Subject: [PATCH] src/utils_threshold.c: Properly document the `ut_check_interesting' function. --- src/utils_threshold.c | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/src/utils_threshold.c b/src/utils_threshold.c index 68b85a37..fd6257c5 100644 --- a/src/utils_threshold.c +++ b/src/utils_threshold.c @@ -833,8 +833,18 @@ int ut_check_threshold (const data_set_t *ds, const value_list_t *vl) return (0); } /* }}} int ut_check_threshold */ +/* + * int ut_check_interesting (PUBLIC) + * + * Given an identification returns + * 0: No threshold is defined. + * 1: A threshold has been found. The flag `persist' is off. + * 2: A threshold has been found. The flag `persist' is on. + * (That is, it is expected that many notifications are sent until the + * problem disappears.) + */ int ut_check_interesting (const char *name) -{ +{ /* {{{ */ char *name_copy = NULL; char *host = NULL; char *plugin = NULL; @@ -887,6 +897,6 @@ int ut_check_interesting (const char *name) if ((th->flags & UT_FLAG_PERSIST) == 0) return (1); return (2); -} /* int ut_check_interesting */ +} /* }}} int ut_check_interesting */ /* vim: set sw=2 ts=8 sts=2 tw=78 fdm=marker : */ -- 2.30.2