libs/rt-thread-official
libs/rt-thread-official
4
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2025-02-25 19:07:04 +08:00
Code Issues Releases Wiki Activity
rt-thread-official/documentation/7.contribution/INDEX.md

11 lines
674 B
Markdown
Raw Normal View History

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
@page page_code_contribution Contribution
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
# Contribution Guide
We sincerely thank you for your contribution, and welcome to submit the code through GitHub's fork and Pull Request processes. RT-Thread 3.1.0 version and its earlier versions follow the GPL V2 open source license agreement. Versions from the 3.1.0 version onwards follow the Apache License 2.0 open source license agreement.
All the real-time operating system kernel and open source components can be used free of charge for commercial products, there is no potential commercial risk and you will not being request to publish application source.
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
@subpage page_rtt_code_style_en
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-06 14:31:06 +08:00
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
@subpage page_howto_doxygen
Copy Permalink