| Age | Commit message (Collapse) | Author |
|---|
|
Add prefix "page_" to the name of pages.
Add this as a rule in guide of writing doxygen documents.
Signed-off-by: Chen Wang <[email protected]>
|
|
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 <[email protected]>
|
|
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 <[email protected]>
|
|
* 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]>
|
|
|
|
Update readme doc to introduce how to build doxygen and run html
on Ubuntu machines.
Signed-off-by: Chen Wang <[email protected]>
|
|
markdown files.
|
|
|
|
https://github.com/RT-Thread/rt-thread/pull/9420
|
|
|
|
Signed-off-by: supperthomas <[email protected]>
|
|
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]>
|
|
|
|
|
|
|
|
and remvoe duplicated default functions in each cpu/bsp level
|
|
|
|
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
|
|
warnings in Doxygen.
将Doxygen输入文件（由Doxyfile中的INPUT定义）中的失效Doxygen分组指令（如/*@*/和/*@}*/）更改为有效的分组指令（如/**@*/和/**@}*/）；（此处只对INPUT中的文件做了修改，bsp目录下和libcpu目录下存在近万个失效的Doxygen分组指令，但由于不作为文档的输入文件且这些文件过于庞大老旧，没有对这些文件中的无效指令做修改）
将图片文件统一放入了images目录下；
修改了Doxyfile和部分Doxygen注释，使得Doxyfile能够定位到新的代码路径且不受重复实现的影响；
解决了一些注释中的参数名不匹配、参数多余/缺失等问题。
|
|
* [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.
|
|
|
|
|
|
|
|
�PWM控制LED，经验证使用这样是无法正常输出PWM的
|
|
rt_ssize_t can give negative error code, which follows the unix style correctly
|
|
|
|
|
|
* Update thread-comm.md
* Update documentation/thread-comm/thread-comm.md
Co-authored-by: Man, Jianting (Meco) <[email protected]>
|
|
* [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
|
|
|
|
|
|
|
|
|
|
append some information about menuconfig -s
|
|
* [document] Fix the doxygen file
|
|
|
|
* Overhaul of document, fixing multiple grammar mistakes and editing for clarity
* Further documentation grammar and spelling fixes
|
|
clarity (#6155)
|
|
* Update English coding style for more idiomatic use
Fresh eyes on the English coding style guide.
Remove "speed bumps" to a native English reader to improve acceptance.
* Coding_style_en: fix plurality disagreement
|
|
将路径更新为IAR最新版本的路径
|
