Commit Graph

2 Commits

Author SHA1 Message Date
Chen Wang
f9655aa8fc doxygen: improve doc for kernel basics section
Organize the document content of the "Kerenl Basics" section.
This PR does not make substantial changes to the text content,
but only makes some optimizations and adjustments to the
document formatting, including:

- Enclose the function name and variable name in "`", so that
  the HTML rendering will use different fonts to distinguish
  them from the text part.

- Add blank lines between paragraphs, otherwise the HTML
  rendering will merge the paragraphs without blank lines
  into one paragraph.

- Use "@ref" to reference the page of the corresponding
  chapter, such as the reference to page_thread_management
  at the end of the "Thread Scheduling" chapter.

- For tables in markdown, try to align the columns in the
  text to beautify the reading experience.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
2025-03-03 15:05:05 +08:00
Chen Wang
75722c4998 doxygen: reorganize directory structure
The original directory structure was too flat and
inconvenient to view.

The directory is now reorganized according to the
first-level chapters, and some sub-chapters are
moved to the second-level directory.

Note: documentation/env is not moved to
documentation/4.tool because there are too many
external places that reference this path,
especially in bsp, so this directory path remains
as it is.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
2025-02-25 11:27:58 +08:00