Commit 40f3b6a
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 <[email protected]>
Co-authored-by: Supper Thomas <[email protected]>1 parent c3e5152 commit 40f3b6a
File tree
133 files changed
+1078
-1052
lines changed- .github/workflows
- documentation
- 0.doxygen
- images
- 1.introduction
- figures
- 2.quick-start
- figures
- keil-installation
- figures
- quick_start_qemu
- figures
- 3.kernel
- 4.tool
- 5.device
- 6.components
- 7.contribution
- at
- basic
- contribution_guide
- device
- adc
- hwtimer
- i2c
- pin
- pwm
- rtc
- sensor
- spi
- uart
- watchdog
- wlan
- dlmodule
- doxygen
- env
- filesystem
- finsh
- interrupt
- kernel-porting
- memory
- network
- pm
- posix
- sal
- scons
- figures
- thread-comm
- thread-sync
- thread
- timer
- ulog
- utest
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
133 files changed
+1078
-1052
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
50 | 50 | | |
51 | 51 | | |
52 | 52 | | |
53 | | - | |
| 53 | + | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
60 | 60 | | |
61 | | - | |
| 61 | + | |
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
| |||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
0 commit comments