Commit bb118ac
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
2 files changed
+12
-10
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
201 | 201 | | |
202 | 202 | | |
203 | 203 | | |
| 204 | + | |
| 205 | + | |
204 | 206 | | |
205 | 207 | | |
206 | 208 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | | - | |
6 | | - | |
7 | | - | |
8 | | - | |
9 | | - | |
10 | | - | |
11 | | - | |
12 | | - | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
0 commit comments