https://github.com/carla-simulator/carla
Raw File
Tip revision: 8447654ecf7e836eb8c97624bb065337ce12caa1 authored by Francesc Domene on 08 August 2019, 16:42:39 UTC
Merge branch 'master' into fdomf/docs
Tip revision: 8447654
cpp_reference.md

<h1>C++ Reference </h1>
We use Doxygen to generate the documentation of our C++ code:

[Libcarla/Source](http://carla.org/Doxygen/html/dir_b9166249188ce33115fd7d5eed1849f2.html)<br>
[Unreal/CarlaUE4/Source](http://carla.org/Doxygen/html/dir_733e9da672a36443d0957f83d26e7dbf.html)<br>
[Unreal/CarlaUE4/Carla/Plugins](http://carla.org/Doxygen/html/dir_8fc34afb5f07a67966c78bf5319f94ae.html)

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](http://www.doxygen.nl/index.html) is required to generate the documentation
    and [Graphviz](https://www.graphviz.org/) for the graph drawing toolkit.

1- Install doxygen and graphviz with the following command:

```sh
# 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:

```sh
> 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!
back to top