summaryrefslogtreecommitdiff
path: root/documentation/doxygen
AgeCommit message (Collapse)Author
2025-01-26doxygen: create framework to unify markdown and source code part (#9946)Chen Wang
* 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 <[email protected]> Co-authored-by: Supper Thomas <[email protected]>
2025-01-03[doc]Update doxygen rtthread_logo.png (#9861)Rbb666
2024-12-22doc: introduce how to build & run doxygen on ubuntuChen Wang
Update readme doc to introduce how to build doxygen and run html on Ubuntu machines. Signed-off-by: Chen Wang <[email protected]>
2024-09-15[doxygen] add driver example for doxygen (#9446)Supper Thomas
2024-06-26[doc][doxygen] Fix doxygen struct error.supperthomas
Signed-off-by: supperthomas <[email protected]>
2024-06-26[doc][doxygen]: Fix doxygen warning in commentsupperthomas
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 <[email protected]>
2023-10-29[action] Doxygen ci fix (#8191)Supper Thomas
2023-08-08rt_hw_cpu_shutdown: implement default weak functionMeco Man
and remvoe duplicated default functions in each cpu/bsp level
2023-04-14[HUST CSE][document] Fix some comments, invalid grouping commands and ↵Xu Biang
warnings in Doxygen. 将Doxygen输入文件(由Doxyfile中的INPUT定义)中的失效Doxygen分组指令(如/*@*/和/*@}*/)更改为有效的分组指令(如/**@*/和/**@}*/);(此处只对INPUT中的文件做了修改,bsp目录下和libcpu目录下存在近万个失效的Doxygen分组指令,但由于不作为文档的输入文件且这些文件过于庞大老旧,没有对这些文件中的无效指令做修改) 将图片文件统一放入了images目录下; 修改了Doxyfile和部分Doxygen注释,使得Doxyfile能够定位到新的代码路径且不受重复实现的影响; 解决了一些注释中的参数名不匹配、参数多余/缺失等问题。
2023-02-02[doxygen] Fix some warnings in doxygen (#6899)tuduweb
2022-08-03[document] Fix the doxygen file (#6217)supperthomas
* [document] Fix the doxygen file
2022-03-12move documentation repo to rt-thread repoMeco Man
2020-11-23【优化】在代码中移除 rt_system_object_init/rt_system_tick_init ↵guozhanxin
的调用。
2020-04-17Update kernel.hDavid Lin
thead -> thread
2014-07-20[Docs] Add RT-Thread logo.bernard
2013-04-10change the version number in the doxygen documentyiyue.fang
1.1.0 -> 1.2.0
2013-01-08convert end of lineBernard Xiong
2012-10-09change the version from 1.0.0 to 1.1.0 in the doxygen[email protected]
git-svn-id: https://rt-thread.googlecode.com/svn/trunk@2330 bbd45198-f89e-11dd-88c7-29a3b14d5316
2012-10-05Add doxygen image.bernard.xiong
git-svn-id: https://rt-thread.googlecode.com/svn/trunk@2319 bbd45198-f89e-11dd-88c7-29a3b14d5316
2012-09-29Add doxygen script files. [email protected]
git-svn-id: https://rt-thread.googlecode.com/svn/trunk@2312 bbd45198-f89e-11dd-88c7-29a3b14d5316