6481633ec6
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 <1078249029@qq.com> |
||
|---|---|---|
| .. | ||
| 0.doxygen | ||
| 1.introduction | ||
| 2.quick-start | ||
| 3.kernel | ||
| 4.tool | ||
| 5.device | ||
| 6.components | ||
| 7.contribution | ||
| at | ||
| basic | ||
| contribution_guide | ||
| device | ||
| dlmodule | ||
| env | ||
| figures | ||
| filesystem | ||
| finsh | ||
| interrupt | ||
| kernel-porting | ||
| memory | ||
| network | ||
| pm | ||
| posix | ||
| sal | ||
| scons | ||
| thread | ||
| thread-comm | ||
| thread-sync | ||
| timer | ||
| ulog | ||
| utest | ||
| Doxyfile | ||
| INDEX.md | ||
| README.md | ||
| run.sh | ||
README.md
How to build doxygen html
- download from https://doxygen.nl/index.html
- open
Doxywizard File->Open- Open the file ./Doxyfile
- To tab
Run, ClickRun doxygen
How to build & run doxygen html on Ubuntu
The following steps are verified on Ubuntu 22.04：
$ lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description: Ubuntu 22.04.5 LTS
Release: 22.04
Codename: jammy
The following packages (and dependents) need to be installed:
$ sudo apt update
$ sudo apt install doxygen
$ sudo apt install graphviz
Assume that the path of RT-Thead code tree is $RTT, execute the following command to build html.
$ cd $RTT/documentation
$ rm -rf html
$ doxygen
A new html directory will be created and all the html files will be placed in this directory.
If you want to quickly browse HTML locally (in Ubuntu environment), you can enter the html directory and start a local HTML server through Python.
$ cd html
$ python3 -m http.server
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...
A bash script run.sh is provided to automatic upon operations.
$ cd $RTT/documentation
$ ./run.sh
Then open the browser and enter http://<IP>:8000/index.html to access the created html web pages. If it is a local access, then <IP> should be replaced by localhost. If it is a remote access, then <IP> should be replaced by the actual accessible IP address of the machine where HTML is located.