Skip to content

Commit bb118ac

Browse files
committed
fix(doc): Correct unexpected "testcases 说明" page in Doxygen output (#10888)
Problem description: The `src/utest/perf/README.md` file was incorrectly displayed in the root level of the Doxygen navigation tree due to missing `@subpage` reference. This caused confusion and made the documentation harder to navigate. Problem analysis: Since the `README.md` file wasn't associated with a parent page via the `@subpage` directive, Doxygen placed it at the root level of the navigation tree instead of nesting it correctly under the "utest Framework" section. Solution: The issue is resolved by: 1. Assigning a unique page ID (`page_component_utest_perf_cases`) and an English title ("utest Performance Test Cases") to the `README.md` file. 2. Updating the `README.md` content to be bilingual, for better alignment with the English documentation. 3. Modifying `documentation/utest.md` to properly reference this page via a `@subpage` directive, ensuring it is correctly nested under the "utest Framework" section. This issue was originally introduced by the following commit: Commit: 7499790 Title: utest: core: move perf testcase from example to src Signed-off-by: lhxj <[email protected]>
1 parent fa6f86e commit bb118ac

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

documentation/6.components/utest/utest.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,8 @@ A basic test case must contain the following:
201201
- test_xxx(void)
202202
203203
Test implementation of each functional unit. The user determines the function name and function implementation based on the requirements.
204+
205+
As a concrete example, the utest module provides a set of performance test cases (located in the src/utest/perf/ directory), which are implemented as a series of test_xxx(void) functions. For more details, see @subpage page_component_utest_perf_cases.
204206
205207
- uassert_true
206208

src/utest/perf/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# testcases 说明
1+
@page page_component_utest_perf_cases utest Performance Test Cases
22

3-
## 一、测试用例说明
3+
# 测试用例说明 (Test Cases Description)
44

5-
| 文件 | 说明 |
6-
|--------|--------|
7-
| context_switch.c | 上下文切换测试代码 |
8-
| irq_latency.c | 中断延时测试代码 |
9-
| rt_perf_thread_event.c | 线程事件性能测试 |
10-
| rt_perf_thread_mbox.c | 线程邮箱性能测试 |
11-
| rt_perf_thread_mq.c | 线程消息队列性能测试 |
12-
| rt_perf_thread_sem.c | 线程信号量性能测试 |
5+
| 文件 (File) | 说明 (Description) |
6+
|--------------|--------------------|
7+
| context_switch.c | 上下文切换测试代码 (Context switch performance test) |
8+
| irq_latency.c | 中断延时测试代码 (Interrupt latency test) |
9+
| rt_perf_thread_event.c | 线程事件性能测试 (Thread event performance test) |
10+
| rt_perf_thread_mbox.c | 线程邮箱性能测试 (Thread mailbox performance test) |
11+
| rt_perf_thread_mq.c | 线程消息队列性能测试 (Thread message queue performance test) |
12+
| rt_perf_thread_sem.c | 线程信号量性能测试 (Thread semaphore performance test) |

0 commit comments

Comments
 (0)