Commit Graph

7 Commits

Author SHA1 Message Date
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
Meco Man c90179beb5 删除rt_thread_sleep遗留 2024-08-15 04:08:33 -04:00
cccccya 0fb99f0242 Revise the description of rt_thread_resume 2023-04-03 00:10:14 -04:00
snikolaj 1fec9dc550
Further edits of documentation for clarity (#6156)
* Overhaul of document, fixing multiple grammar mistakes and editing for clarity

* Further documentation grammar and spelling fixes
2022-07-11 10:19:16 +08:00
snikolaj 3883fcf051
Overhaul of document, fixing multiple grammar mistakes and editing for clarity (#6155) 2022-07-10 18:01:56 +08:00
Meco Man 5af97a1f7f move documentation repo to rt-thread repo 2022-03-12 00:56:03 -05:00