Add Doxygen

This commit is contained in:
Ashcon Mohseninia 2022-02-24 15:42:24 +00:00
parent f319c7dbf7
commit 5f78c576da
3 changed files with 2626 additions and 1 deletions

2618
Doxyfile Normal file

File diff suppressed because it is too large Load Diff

View File

@ -9,3 +9,10 @@ For context on this project, checkout my [video playlist](https://youtube.com/pl
I am in no way responsible if your gearbox or car dies as a result of using this firmware!
Although this firmware is being tested actively, there are loads of unknowns which may occur rarely during operation that
are not tested yet.
## Generating the code documentation
1. Install [doxygen](https://www.doxygen.nl/manual/install.html)
2. Clone doxygen-awesome-css submodule with `git submodule update --init --recursive`
3. Run `doxygen`
4. View code documentation in the generated `html` folder

@ -1 +1 @@
Subproject commit f7d92e49f2d720bbfe67c1e819cc06e544acf122
Subproject commit 9380569e8aea36374d848c8a43c6f9c6343d9bc0