Ashin Walpola
d107534eb2
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.
646 B
646 B
Title: API Documentation
An API documentation can be generated directly from source code with Doxygen.
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 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.