C++ Reference

We use Doxygen to generate the documentation of our C++ code:

Libcarla/Source
Unreal/CarlaUE4/Source
Unreal/CarlaUE4/Carla/Plugins

The generated documentation is available at this link http://carla.org/Doxygen/html/index.html

Note

Document updates are done automatically by GitHub.

Create doxygen documentation

Important

Doxygen is required to generate the documentation and Graphviz for the graph drawing toolkit.

1- Install doxygen and graphviz with the following command:

# linux
> sudo apt-get install doxygen graphviz

2- Once installed, go to the project root folder where the Doxyfile file is situated and run the following command:

> doxygen

It will start to build the documentation webpage.
The resulting webpage can be found at Doxygen/html/

3- Open index.html in a browser. Now you have your local cpp documentation!