diff --git a/doc/README b/doc/README index a132a0d8b12237675cd76e38430f3ac963bc5c36..2d8755731b0f4b5faa5d905af99fecd14d7ee0bf 100644 --- a/doc/README +++ b/doc/README @@ -1,7 +1,7 @@ -Linux/Mac OS X -============== -To install doxygen: -$sudo apt-get install doxygen +Mac OS X +======== +To install doxygen and dot: +brew install doxygen dot doxyqml: https://github.com/agateau/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: $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. diff --git a/doc/graphs.graffle b/doc/graphs.graffle index 70054f963c2ae4bf09c66a6432f61a9b942786ed..c5fbe212e892be2b90fb9d5fe184ccfcc357bdbf 100644 Binary files a/doc/graphs.graffle and b/doc/graphs.graffle differ diff --git a/doc/links.svg b/doc/links.svg index d08d6db191264471de146f61a0fbf1a304a404b5..6e9b4987abe37aad470c4af5503410808da4a0fc 100644 --- a/doc/links.svg +++ b/doc/links.svg @@ -1,8 +1,8 @@ - + - + @@ -16,16 +16,16 @@ - + - + - + @@ -36,32 +36,47 @@ - + - + + + + + + + + + + + + + + + + Produced by OmniGraffle 7.12.1 - 2020-02-01 16:48:51 +0000 + 2020-02-02 19:58:23 +0000 Canvas 1 Layer 1 - - - + + + LinkManager - - - + + + LinkConfiguration @@ -80,50 +95,52 @@ - - - + + + UDPConfiguration - - - - - Signal - bytesReceived - - - - - - - Method - writeBytesSafe - - - - - - - - - - - - + + + + + + Signal + bytesReceived + + + + + + + Method + writeBytesSafe + + + + + + + + + + - + - + - + - + + + + diff --git a/doc/qgcmain.svg b/doc/qgcmain.svg new file mode 100644 index 0000000000000000000000000000000000000000..58e9af650851ae95af35b644192f82e428fe2d9e --- /dev/null +++ b/doc/qgcmain.svg @@ -0,0 +1,192 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Produced by OmniGraffle 7.12.1 + 2020-02-02 21:29:41 +0000 + + + Canvas 1 + + Layer 1 + + + + + Vehicle + + + + + + + LinkInterface + + + + + + + Telemetry + Link + + + + + + + MAVLinkProtocol + + + + + + + + + + + + + + + + + + + LinkManager + + + + + + + MultiVehicleManager + + + + + + + UI + + + + + + + + + + + + + + + + + + + QGCCameraManager + + + + + + + QGCCameraControl + + + + + + + + + + + + + + + + VideoManager + + + + + + + VideoReceiver + + + + + + + + + + Video + Link + + + + + + + + + + + diff --git a/doc/qgroundcontrol.md b/doc/qgroundcontrol.md index 9035770974865885dbf0bfc84632be9c0b0fc057..d381c73fc292d689f6e44deeecb4ae52bd37b810 100644 --- a/doc/qgroundcontrol.md +++ b/doc/qgroundcontrol.md @@ -1,5 +1,11 @@ QGroundControl Architecture Documentation {#mainpage} ========================================= +#### High Level Diagram + +
+ +
+ * [Link Management](links.md) * [Vehicle Management](vehicleMgmt.md) diff --git a/doc/vehicleMgmt.md b/doc/vehicleMgmt.md index c3bbc9cceb1455a14c267292b57a42c4521facf0..68be935005f3bb4b60d8dcfd40b7d0f91ed4768b 100644 --- a/doc/vehicleMgmt.md +++ b/doc/vehicleMgmt.md @@ -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 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.
diff --git a/doc/vehicleMgmt.svg b/doc/vehicleMgmt.svg index 5e84a2f40eae4c691280f0e956b9244ac12e8e4e..657b511f78b057138e045a655901106c5698c5ae 100644 --- a/doc/vehicleMgmt.svg +++ b/doc/vehicleMgmt.svg @@ -1,8 +1,8 @@ - + - + @@ -32,27 +32,27 @@ - + - - - - + + + + - - - + + + - + Produced by OmniGraffle 7.12.1 - 2020-02-01 16:48:51 +0000 + 2020-02-02 20:02:31 +0000 Canvas 1 @@ -66,59 +66,59 @@ - - - - Slot - bytesReceived + + + + Slot + bytesReceived - - + + - - - - Signal - vehicleHeartbeatInfo + + + + Signal + vehicleHeartbeatInfo - - + + - - - + + + MultiVehicleManager - - - - Signal - messageReceived + + + + Signal + messageReceived - - + + - - - - Slot - vehicleHeartbeatInfo + + + + Slot + vehicleHeartbeatInfo - - + + @@ -128,31 +128,31 @@ - - - - Slot - messageReceived + + + + Slot + messageReceived - - + + - - + + - Call - writeBytesSafe + Call + writeBytesSafe - - + + - +