From patchwork Thu Dec 21 06:39:33 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Grant Erickson X-Patchwork-Id: 13501207 Received: from mohas.pair.com (mohas.pair.com [209.68.5.112]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E62FCBA33 for ; Thu, 21 Dec 2023 06:40:20 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=nuovations.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=nuovations.com Received: from mohas.pair.com (localhost [127.0.0.1]) by mohas.pair.com (Postfix) with ESMTP id 2573B73202 for ; Thu, 21 Dec 2023 01:40:20 -0500 (EST) Received: from localhost.localdomain (unknown [IPv6:2601:647:5a00:15c1:f5ab:4a5e:2861:14b3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mohas.pair.com (Postfix) with ESMTPSA id DBD8373219 for ; Thu, 21 Dec 2023 01:40:19 -0500 (EST) From: Grant Erickson To: connman@lists.linux.dev Subject: [PATCH v2 29/60] service: Document 'online_check_failures_threshold_was_met_set_value'. Date: Wed, 20 Dec 2023 22:39:33 -0800 Message-ID: <20231221064007.2347566-30-gerickson@nuovations.com> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231221064007.2347566-1-gerickson@nuovations.com> References: <20231221064007.2347566-1-gerickson@nuovations.com> Precedence: bulk X-Mailing-List: connman@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Scanned-By: mailmunge 3.11 on 209.68.5.112 This adds documentation to the 'online_check_failures_threshold_was_met_set_value' function. --- src/service.c | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/service.c b/src/service.c index e8fc14f1c4ca..b41f29d73d60 100644 --- a/src/service.c +++ b/src/service.c @@ -2191,6 +2191,20 @@ static bool online_check_failures_threshold_was_met( return service->online_check_failures_met_threshold; } +/** + * @brief + * Set the online check failures threshold state to the specified + * value. + * + * @param[in,out] service A pointer to the mutable service for which + * to set the failures threshold state. + * @param[in] value The value to set the @a service failures + * threshold state to. + * + * @sa online_check_failures_threshold_was_met_set + * @sa online_check_failures_threshold_was_met_clear + * + */ static void online_check_failures_threshold_was_met_set_value( struct connman_service *service, bool value) {