testdiff2/SpiriQGC/doc
kebab d5db18cf96 finalized 2023-12-21 08:03:49 -05:00
..
.gitignore finalized 2023-12-21 08:03:49 -05:00
Doxyfile finalized 2023-12-21 08:03:49 -05:00
README finalized 2023-12-21 08:03:49 -05:00
dot finalized 2023-12-21 08:03:49 -05:00
graphs.graffle finalized 2023-12-21 08:03:49 -05:00
header.html finalized 2023-12-21 08:03:49 -05:00
links.md finalized 2023-12-21 08:03:49 -05:00
links.svg finalized 2023-12-21 08:03:49 -05:00
qgcmain.svg finalized 2023-12-21 08:03:49 -05:00
qgroundcontrol.md finalized 2023-12-21 08:03:49 -05:00
qgroundcontrol.png finalized 2023-12-21 08:03:49 -05:00
vehicleMgmt.md finalized 2023-12-21 08:03:49 -05:00
vehicleMgmt.svg finalized 2023-12-21 08:03:49 -05:00

README

Mac OS X
========
To install doxygen and dot: 
brew install doxygen dot

doxyqml:
https://github.com/agateau/doxyqml
$sudo pip3 install doxyqml

Then to generate the html, run the following code while you are in the qgroundcontrol/doc directory:
$doxygen Doxyfile

The html file index.html should be in doc/html. 

Debian
=====================
#To build documentation first install dependencies (doxygen, doxyqml and dot):
sudo apt install doxygen graphviz doxyqml

#Then build documentation in the doc/ directory
doxygen ./Doxyfile