ashin-walpola/MicrOBU
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Keep vanetza-idf in obu-firmware, so a plain clone builds the firmware

Browse Source 
obu-firmware builds against the vanetza-idf C-ITS library, which until now
came from the colleague's microbu-esp32c5 tree beside the repository and was
not tracked here, so a clone of this repository could not build the firmware
it ships. The library alone is now part of obu-firmware, as
obu-firmware/external/vanetza-idf: their external/vanetza-idf at commit
cf4b99f, unchanged (9775 files; see its PROVENANCE.md). CMake takes it from
there by default; -DVANETZA_IDF_DIR still points the build elsewhere.

The rest of the colleague's tree (their own VAM firmware, PKI tooling,
station-link Python tools, the V2X2MAP bridge) stays out of this repository
and gitignored; nothing is pushed to their repository. NOTES.md, docs/06,
TODO.md and the pcap verifier's usage line point at the new location.
This commit is contained in:
Ashin Walpola
2026-09-24 10:56:05 +02:00
parent 2f60623e18
commit d107534eb2
9781 changed files with 1560475 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
obu-firmware/external/vanetza-idf/docs/api.md
Vendored
+10
View File
@@ -0,0 +1,10 @@
Title: API Documentation
An API documentation can be generated directly from source code with [Doxygen](http://www.doxygen.nl).
If Doxygen is installed on your system, you may simply call `doxygen` in the repository's root directory.
The generated HTML documentation can then be found at *doxygen/html/index.html*.
We also maintain an [online copy](https://www.vanetza.org/doxygen/index.html) which is updated every now and then.
Of course, your locally generated documentation will be more up-to-date in most cases.
Please consider to generate the documentation locally if you need it to match a particular or more recent version of Vanetza.