8 Commits

Author	SHA1	Message	Date
Chen Wang	3c046646cb	doxygen: promote object management to a separate page ... For "RT-Thread User Guide": Take the "RT-Thread Kernel Object Model" sub-section out of the "Kernel Basics" section and rename it to "Object Management". Correspondingly, rename the "Kernel Object Management" section in the "RT-Thread API Guide" to "Object Management". Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-07-22 18:07:17 +08:00
Chen Wang	443c530c3c	doxygen: fix one typo issue (#10200) ... Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-04-18 14:04:16 +08:00
Chen Wang	55428e4393	doxygen: re-org module groups (#10197) ... Match the organization of modules (groups) with that of user guide. Preliminary arrangement. This patch is just a framework arrangement. Details need to be continued. P.S., in this patch, adding numerical prefixes to the files in documentation/0.doxygen is to meet the need of displaying sorting in HTML pages. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-04-18 10:44:43 +08:00
Chen Wang	5a42cfd16b	doxygen: update doc for kenrel object model ... Move the introduction of function parameters in markdown to source code comments, because this part of the content is completely repeated. We only need to keep and maintain the comments in the code. The detailed explanation of the API in markdown can directly refer to the comments in the code. Try not to directly copy the definition of the structure in the markdown document, because this part of the content may change with the upgrade of the code. Therefore, when the structure definition is involved in markdown, try to indicate that it is just a code snippet. The specific definition is still directly quoted from the source code and the source code comments. It is very convenient to quote structures and functions in markdown. Just use "`" to enclose the structure name or function name, and the generated html is a link to its definition. According to this principle, this patch only modifies the documents and code comments of the kernel object model. Other modules will be modified one by one in separate patches later. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-03-12 12:54:25 +08:00
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
Chen Wang	f6f7d91a61	doxygen: add prefix for page name (#9989) ... Add prefix "page_" to the name of pages. Add this as a rule in guide of writing doxygen documents. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-02-13 23:28:19 +08:00
Chen Wang	40f3b6a569	doxygen: create framework to unify markdown and source code part (#9946) ... * doxygen: adjust documentation directory structure - Rename documentation/doxygen to documentation/0.doxygen and cleanup some unused files. - Add/rename folders for each sub sections, such as 1.introduction/...... Each sub section will be created as a subpage. - Generate initial Doxyfile, this Doxyfile will be used to unify doxygen generated API documents and those markdown files under documentation folder. This patch just add the default Doxyfile generated by running "doxygen -g". It is used as baseline to add more features/configurations. - Rename documentation/README.md to documentation/INDEX.md, and use it as mainpage. - Move 0.doxygen/readme.md to documentation/README.md. * doxygen: update configurations These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. * doxygen: add run script Add a script to automatic some operations. Updated the README.md. --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com> Co-authored-by: Supper Thomas <78900636@qq.com>	2025-01-26 11:44:39 +08:00