testdiff2/doc
kebab 94781b40f2 second 2023-12-06 13:21:56 -05:00
..
.gitignore first 2023-12-06 12:51:14 -05:00
Doxyfile second 2023-12-06 13:21:56 -05:00
README first 2023-12-06 12:51:14 -05:00
dot first 2023-12-06 12:51:14 -05:00
graphs.graffle first 2023-12-06 12:51:14 -05:00
header.html first 2023-12-06 12:51:14 -05:00
links.md first 2023-12-06 12:51:14 -05:00
links.svg first 2023-12-06 12:51:14 -05:00
qgcmain.svg first 2023-12-06 12:51:14 -05:00
qgroundcontrol.md first 2023-12-06 12:51:14 -05:00
qgroundcontrol.png first 2023-12-06 12:51:14 -05:00
vehicleMgmt.md first 2023-12-06 12:51:14 -05:00
vehicleMgmt.svg first 2023-12-06 12:51:14 -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