Skip to content

Commit 86f4860

Browse files
finikorgcarlescufi
authored andcommitted
doc: ztest: Include ztress to API reference
Include ztress documentation to ztest API section. Signed-off-by: Andrei Emeltchenko <[email protected]>
1 parent 0239a2c commit 86f4860

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

doc/develop/test/ztest.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -481,6 +481,11 @@ Example output for a failed macro from
481481

482482
.. _mocking-fff:
483483

484+
Ztress
485+
======
486+
487+
.. doxygengroup:: ztest_ztress
488+
484489
Mocking via FFF
485490
===============
486491

subsys/testsuite/ztest/include/zephyr/ztress.h

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
*
44
* SPDX-License-Identifier: Apache-2.0
55
*/
6+
7+
/**
8+
* @file
9+
*
10+
* @brief Zephyr testing framework ztress macros
11+
*/
12+
613
#ifndef TESTSUITE_ZTEST_INCLUDE_ZTRESS_H__
714
#define TESTSUITE_ZTEST_INCLUDE_ZTRESS_H__
815

@@ -17,6 +24,15 @@ extern "C" {
1724
#define ZTRESS_ID_THREAD 0
1825
#define ZTRESS_ID_K_TIMER 1
1926

27+
/**
28+
* @defgroup ztest_ztress Ztest ztress macros
29+
* @ingroup ztest
30+
*
31+
* This module provides test stress when using Ztest.
32+
*
33+
* @{
34+
*/
35+
2036
/** @brief Descriptor of a k_timer handler execution context.
2137
*
2238
* The handler is executed in the k_timer handler context which typically means
@@ -237,6 +253,10 @@ int ztress_preempt_count(uint32_t id);
237253
*/
238254
uint32_t ztress_optimized_ticks(uint32_t id);
239255

256+
/**
257+
* @}
258+
*/
259+
240260
#ifdef __cplusplus
241261
}
242262
#endif

0 commit comments

Comments
 (0)