From 86f48609fbfb99e7697b14cd549722246cf6eabe Mon Sep 17 00:00:00 2001 From: Andrei Emeltchenko Date: Thu, 12 Jan 2023 13:48:23 +0200 Subject: [PATCH] doc: ztest: Include ztress to API reference Include ztress documentation to ztest API section. Signed-off-by: Andrei Emeltchenko --- doc/develop/test/ztest.rst | 5 +++++ .../testsuite/ztest/include/zephyr/ztress.h | 20 +++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/doc/develop/test/ztest.rst b/doc/develop/test/ztest.rst index cb015bdba80..48da60c12f3 100644 --- a/doc/develop/test/ztest.rst +++ b/doc/develop/test/ztest.rst @@ -481,6 +481,11 @@ Example output for a failed macro from .. _mocking-fff: +Ztress +====== + +.. doxygengroup:: ztest_ztress + Mocking via FFF =============== diff --git a/subsys/testsuite/ztest/include/zephyr/ztress.h b/subsys/testsuite/ztest/include/zephyr/ztress.h index 666f546e7e4..57cba174fda 100644 --- a/subsys/testsuite/ztest/include/zephyr/ztress.h +++ b/subsys/testsuite/ztest/include/zephyr/ztress.h @@ -3,6 +3,13 @@ * * SPDX-License-Identifier: Apache-2.0 */ + +/** + * @file + * + * @brief Zephyr testing framework ztress macros + */ + #ifndef TESTSUITE_ZTEST_INCLUDE_ZTRESS_H__ #define TESTSUITE_ZTEST_INCLUDE_ZTRESS_H__ @@ -17,6 +24,15 @@ extern "C" { #define ZTRESS_ID_THREAD 0 #define ZTRESS_ID_K_TIMER 1 +/** + * @defgroup ztest_ztress Ztest ztress macros + * @ingroup ztest + * + * This module provides test stress when using Ztest. + * + * @{ + */ + /** @brief Descriptor of a k_timer handler execution context. * * The handler is executed in the k_timer handler context which typically means @@ -237,6 +253,10 @@ int ztress_preempt_count(uint32_t id); */ uint32_t ztress_optimized_ticks(uint32_t id); +/** + * @} + */ + #ifdef __cplusplus } #endif