Commit cc74ecea authored by Gus Grubba's avatar Gus Grubba

Add a high level diagram.

Tweak output.
parent 2c04ad3c
Linux/Mac OS X Mac OS X
============== ========
To install doxygen: To install doxygen and dot:
$sudo apt-get install doxygen brew install doxygen dot
doxyqml: doxyqml:
https://github.com/agateau/doxyqml https://github.com/agateau/doxyqml
...@@ -10,5 +10,5 @@ $sudo pip3 install doxyqml ...@@ -10,5 +10,5 @@ $sudo pip3 install doxyqml
Then to generate the html, run the following code while you are in the qgroundcontrol/doc directory: Then to generate the html, run the following code while you are in the qgroundcontrol/doc directory:
$doxygen Doxyfile $doxygen Doxyfile
The html file index.html should be in doc/html unless you chenged the output directory. The html file index.html should be in doc/html.
No preview for this file type
This diff is collapsed.
This diff is collapsed.
QGroundControl Architecture Documentation {#mainpage} QGroundControl Architecture Documentation {#mainpage}
========================================= =========================================
#### High Level Diagram
<div align="center">
<img src="../qgcmain.svg" style="width:80%; height=auto;">
</div>
* [Link Management](links.md) * [Link Management](links.md)
* [Vehicle Management](vehicleMgmt.md) * [Vehicle Management](vehicleMgmt.md)
...@@ -7,7 +7,7 @@ it emits MAVLinkProcotol::vehicleHeartbeatInfo signals. ...@@ -7,7 +7,7 @@ it emits MAVLinkProcotol::vehicleHeartbeatInfo signals.
The singleton MultiVehicleManager is responsible for creating and maintaining instances of the Vehicle class. When it receives a MAVLinkProcotol::vehicleHeartbeatInfo The singleton MultiVehicleManager is responsible for creating and maintaining instances of the Vehicle class. When it receives a MAVLinkProcotol::vehicleHeartbeatInfo
signal for the first time, it creates a vehicle instance, recording the vehicle ID and the link used. signal for the first time, it creates a vehicle instance, recording the vehicle ID and the link used.
The Vehicle class holds all the functionality to handle vehicles. It receives all messages sent from the vehicle and manage all messages and commands to that vehicle. The Vehicle class holds all the functionality to handle vehicles. It receives all messages sent from the vehicle and manages all messages and commands to that vehicle.
<div align="center"> <div align="center">
<img src="../vehicleMgmt.svg" style="width:80%; height=auto;"> <img src="../vehicleMgmt.svg" style="width:80%; height=auto;">
......
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment