101 Commits

Author	SHA1	Message	Date
Chen Wang	94afe6a4f1	doxygen: improve howto ... - Add description on how to group macros. - Add description for structs on how to write comments for members when the name of member is too. - Use @ref to link group instead of the html filenames. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-03-10 10:08:48 +08:00
Chen Wang	3c8b23576f	doxygen: group examples in subpages ... Doxygen examples are grouped on different pages so that you can easily link to pages of related types in the documentation. For example, macro examples have their own page, and function examples have their own page, which correspond to their own code examples, such as "macro.h" or "function.h". Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-03-06 11:46:21 +08:00
1078249029	ed8d0bc36b	[doxygen][audio] Fix doxygen comments for audio component ... Added comments for data structure and rt_audio_ops in dev_audio.h. Enriched comments for macro group. Moved and renamed folder audio. Signed-off-by: 1078249029 <1078249029@qq.com>	2025-03-06 11:45:07 +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
wumingzi	fb64052722	[RFC][doxygen]Doxygen comment standard processing (#10058) ... Signed-off-by: 1078249029 <1078249029@qq.com>	2025-03-01 16:02:17 +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	aa3328f35d	doxygen: Improve the text description of the introduction section ... Adjust the paragraph format and correct some inaccurate statements. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-02-21 21:58:19 -05:00
Chen Wang	9dd309df26	doxygen: support running from the root directory ... Previously, you had to enter the documentation directory before executing the run.sh script, which was not very convenient during development, especially when you needed to execute other commands in the source code root directory at the same time, such as git commands. Now you can directly run script in the source code root directory as below: ```shell $ cd $RTT $ ./documentation/run.sh ``` No need to switch the working path any more after entering the source code root directory. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-02-21 21:58:01 -05:00
Chen Wang	5b6944f7fa	doxygen: More strict checks on build results (#10007) ... Github CI doc_doxygen is very strict in checking the build results, and will output failure even if there are warnings. In order to match CI's checks, local build scripts are also checked more strictly to detect potential errors and even warnings as early as possible. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-02-19 21:21:04 +08:00
wumingzi	600e4ab517	Add recommanded script and extension for writing doxygen comments on … (#10001) ... Add recommanded script and extension for writing doxygen comments on vscode Signed-off-by: 1078249029 <1078249029@qq.com>	2025-02-19 09:06:15 +08:00
Chen Wang	c40b79037c	doxygen: add prefix for groups (#9991) ... * doxygen: add prefix for groups Add "group_" prefix to doxygen group names. This makes it easier to grep with group name later. This patch only modifies the groups defined in the pathes of INPUT of documentation/Doxyfile: INPUT = . \ ../src \ ../include \ ../components/finsh \ ../components/drivers/include/drivers \ ../components/drivers/clk \ ../components/dfs/dfs_v2/src \ ../components/dfs/dfs_v2/include Other groups are not touched. Signed-off-by: Chen Wang <unicorn_wang@outlook.com> * ci: fixed error report when run file_check.py Such as: - "please delete extra space at the end of this line." - "the RT-Thread error code should return negative value. e.g. return -RT_ERROR" Signed-off-by: Chen Wang <unicorn_wang@outlook.com> --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-02-15 12:15:19 +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	761bb89f27	doxygen: add documentation for doxygen ... Documentation is provided to clarify how to write doxygen documentation for RT-Thread. This document is also integrated as part of RT-Thread doxygen documentation. An example is also provided. The original README.md is removed and integrated into this document. Updated github actions for doxygen too. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-02-11 17:09:44 +08:00
wumingzi	6481633ec6	[doxygen] add doxygen comment for clk.c and clk.h (#9950) ... Accroding to #9947 and #9424, adding doxygen comment for function in .c files and data structure, macro in .h file is a solution.For this pr, I encountered problem following situations. - rt_clk_unprepare function return value type is different from rt_clk_ops so I change type of rt_clk_unprepare and its dependencies. - clk_get function may be similar as rt_clk_unprepare but I'm not sure so not modify. - clk_release implements may be incomplete, so I just marked in comment. Signed-off-by: 1078249029 <1078249029@qq.com>	2025-01-27 15:54:13 +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
Rbb666	1284d40ea5	[doc]Update doxygen rtthread_logo.png (#9861)	2025-01-03 13:33:46 +08:00
Chen Wang	f31a87926e	doc: introduce how to build & run doxygen on ubuntu ... Update readme doc to introduce how to build doxygen and run html on Ubuntu machines. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2024-12-22 23:09:02 -05:00
ligr	e5bc2dbdc6	[documentation][Finsh]fix the wrong comments for FINSH_USING_SYMTAB macro in markdown files.	2024-11-26 22:17:17 -05:00
Supper Thomas	6320f184f5	[doxygen] add driver example for doxygen (#9446)	2024-09-15 08:22:44 +08:00
CXSforHPU	bb91502465	[drivers] Specifies the name of the drivers driver file ... https://github.com/RT-Thread/rt-thread/pull/9420	2024-09-13 17:40:40 -04:00
Meco Man	c90179beb5	删除rt_thread_sleep遗留	2024-08-15 04:08:33 -04:00
supperthomas	14e4c45408	[doc][doxygen] Fix doxygen struct error. ... Signed-off-by: supperthomas <78900636@qq.com>	2024-06-26 20:22:43 +08:00
supperthomas	038ff8b2e5	[doc][doxygen]: Fix doxygen warning in comment ... kservice.c:474: warning: The following parameter of rt_backtrace_to_buffer(rt_thread_t thread, struct rt_hw_backtrace_frame *frame, long skip, rt_ubase_t *buffer, long buflen) is not documented: parameter 'thread' kernel.h:157: warning: unable to resolve reference to '_rt_errno' for \ref command Signed-off-by: supperthomas <78900636@qq.com>	2024-06-26 01:21:57 +08:00
wdfk-prog	d8dcc05174	[mem] Remove useless code And Update mem documentation	2024-04-18 20:04:15 -04:00
Meco Man	589641258e	[debug] rename RT_DEBUGING_INIT as RT_DEBUGING_AUTO_INIT	2023-11-10 05:24:33 -05:00
Supper Thomas	65623777d5	[action] Doxygen ci fix (#8191)	2023-10-29 13:12:29 -04:00
Meco Man	c6a2f5b7bd	rt_hw_cpu_shutdown: implement default weak function ... and remvoe duplicated default functions in each cpu/bsp level	2023-08-08 22:34:25 -04:00
Meco Man	9f88f10e82	[docs] add env vscode document	2023-07-30 00:40:52 -04:00
Meco Man	e44761c169	[.github] add CONTRIBUTING.md ... https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors	2023-07-28 22:38:22 -04:00
Meco Man	9cffb706ba	[doc][qemu] update qemu for windows doc	2023-07-25 22:50:22 -04:00
Meco Man	f01fe4aacb	[docs][qemu] update quick_start_qemu_windows	2023-07-25 20:28:03 -04:00
Meco Man	27143f4138	[doc][env] update env document	2023-07-23 22:54:40 -04:00
Man, Jianting (Meco)	244b903e5d	[debug] 整理debug宏并增加RT_DEBUGING_CONTEXT (#7805)	2023-07-22 10:36:42 +08:00
Meco Man	237bbfd968	[debug] remove RT_DEBUG_xxx ... remove RT_DEBUG_THREAD RT_DEBUG_SCHEDULER RT_DEBUG_IPC RT_DEBUG_TIMER RT_DEBUG_IRQ RT_DEBUG_MEM RT_DEBUG_SLAB RT_DEBUG_MEMHEAP	2023-07-09 00:19:29 -04:00
Legend	7122aba397	[docs] fix a typo in documentation (#7773)	2023-07-03 16:03:59 -04:00
Shicheng Chu	e2c031643c	[include][dbg]update: no longer use RT_DEBUG_LOG in rtdebug.h (#7750)	2023-06-29 11:24:25 -04:00
zhkag	33f550cb65	[Kernel] message 可以返回消息的实际大小 (#7709)	2023-06-21 18:22:42 +08:00
shandianchengzi	a294d7da9a	[HUST CSE][example] fix some typo bugs about 'sucess' and others. (#7528)	2023-05-18 10:42:44 -04:00
michael-skynorth	65a2a811ed	env.md: Update URL to download env tool	2023-05-07 22:40:44 -04:00
Xu Biang	2c98ce4605	[HUST CSE][document] Fix some comments, invalid grouping commands and warnings in Doxygen. ... 将Doxygen输入文件（由Doxyfile中的INPUT定义）中的失效Doxygen分组指令（如/*@*/和/*@}*/）更改为有效的分组指令（如/**@*/和/**@}*/）；（此处只对INPUT中的文件做了修改，bsp目录下和libcpu目录下存在近万个失效的Doxygen分组指令，但由于不作为文档的输入文件且这些文件过于庞大老旧，没有对这些文件中的无效指令做修改） 将图片文件统一放入了images目录下； 修改了Doxyfile和部分Doxygen注释，使得Doxyfile能够定位到新的代码路径且不受重复实现的影响； 解决了一些注释中的参数名不匹配、参数多余/缺失等问题。	2023-04-14 12:33:43 -04:00
Bernard Xiong	9600b75b55	[DFS] prepare for dfs_v2.0 (#7200) ... * [DFS] prepare for dfs_v2. dfs_fd -> dfs_file; dfs_fnode -> dfs_vnode. * [BSP] fix code analysis warning * [smart] fix the pointer overflow. * code format * [smart] fix the lwp->lwp_obj checking.	2023-04-08 22:25:51 +08:00
cccccya	0fb99f0242	Revise the description of rt_thread_resume	2023-04-03 00:10:14 -04:00
Meco Man	eb3cb250be	[errno code][-RT_ETIMEOUT] fix that use RT_ETIMEOUT without -	2023-03-22 01:54:52 -04:00
Meco Man	0f461e870c	[errno code][-RT_ERROR] fix that use RT_ERROR without -	2023-03-20 00:06:16 -04:00
slhuan	e722733178	修改doc文件夹下pwm例程中将led的io设置为输出模式后再使用PWM控制LED，经验证使用这样是无法正常输出PWM的	2023-03-07 22:04:09 -05:00
Meco Man	f58d3c5200	rt_device_write/read return data type as rt_ssize_t ... rt_ssize_t can give negative error code, which follows the unix style correctly	2023-02-07 21:43:57 -05:00
tuduweb	9fbf63441e	[doxygen] Fix some warnings in doxygen (#6899)	2023-02-02 21:00:58 -05:00
Meco Man	ddccef3a64	modify RT_ALIGN_SIZE as 8 by default	2023-01-12 22:47:23 -05:00
sbb	961b020bc2	documention里的一处小问题 (#6748) ... * Update thread-comm.md * Update documentation/thread-comm/thread-comm.md Co-authored-by: Man, Jianting (Meco) <920369182@qq.com>	2022-12-16 23:51:09 -05:00
Man, Jianting (Meco)	99bdf978d7	[rtdef] use lower-case to define attributes (#6728) ... * [rtdef] rename RT_WEAK attribute as rt_weak * [rtdef] rename RT_USED attribute as rt_used * [rtdef] rename RT_SECTION attribute as rt_section * [rtdef] rename ALIGN attribute as rt_align * [legacy] add RT_USED ALIGN RT_SECTION RT_WEAK as legacy support	2022-12-11 13:12:03 -05:00