dark0707
/
px4-firmware
forked from Archive/PX4-Autopilot
1
0
Fork 0
Code Pull Requests Activity
px4-firmware/Documentation
History
Lorenz Meier 525cc1a37c Added docs 2013-04-28 18:21:06 +02:00
..
Doxyfile Fresh import of the PX4 firmware sources. 2012-08-04 15:12:36 -07:00
README Fresh import of the PX4 firmware sources. 2012-08-04 15:12:36 -07:00
arming_state_machine.odg Major push in state machine cleanup 2013-01-20 19:47:21 +01:00
arming_state_machine.pdf Major push in state machine cleanup 2013-01-20 19:47:21 +01:00
code_structure_diagrams.odg docu diagrams: removed old inter app communication, updated state machine (is now also in a separate file) 2012-08-20 13:20:57 +02:00
code_structure_diagrams.pdf Fresh import of the PX4 firmware sources. 2012-08-04 15:12:36 -07:00
commander_app.odg made the commander app docu diagram nicer 2012-08-19 14:22:34 +02:00
commander_app.png made the commander app docu diagram nicer 2012-08-19 14:22:34 +02:00
control_flow.graffle Added docs 2013-04-28 18:21:06 +02:00
doxygen.sh Fresh import of the PX4 firmware sources. 2012-08-04 15:12:36 -07:00
flight_mode_state_machine.odg Updated docs 2013-01-21 23:44:15 +01:00
flight_mode_state_machine.pdf Updated docs 2013-01-21 23:44:15 +01:00
position_control.odg added position control documentation diagram 2012-08-15 16:21:24 +02:00
position_control.png added position control documentation diagram 2012-08-15 16:21:24 +02:00
position_estimator_app.odg Fresh import of the PX4 firmware sources. 2012-08-04 15:12:36 -07:00
position_estimator_app.pdf Fresh import of the PX4 firmware sources. 2012-08-04 15:12:36 -07:00
position_estimator_app.png Fresh import of the PX4 firmware sources. 2012-08-04 15:12:36 -07:00
px4_general_structure.png Fresh import of the PX4 firmware sources. 2012-08-04 15:12:36 -07:00
rc_mode_switch.odg Updated state machine docs after first review round 2013-01-27 12:44:06 +01:00
rc_mode_switch.pdf Updated state machine docs after first review round 2013-01-27 12:44:06 +01:00
state_machine.odg docu diagrams: removed old inter app communication, updated state machine (is now also in a separate file) 2012-08-20 13:20:57 +02:00
state_machine.png docu diagrams: removed old inter app communication, updated state machine (is now also in a separate file) 2012-08-20 13:20:57 +02:00
versionfilter.sh Fresh import of the PX4 firmware sources. 2012-08-04 15:12:36 -07:00

README 

Linux/Mac OS X
==============
To install doxygen: 
$sudo apt-get install doxygen

If the above does not work go to:
http://www.stack.nl/~dimitri/doxygen/download.html for the correct download.

Then go to the following website for inforamtion on the install:
http://www.stack.nl/~dimitri/doxygen/install.html

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 changed the output directory. 

The other option for generating the documentation is to use the wizard:
$doxywizard &

doxywizard information:
http://www.stack.nl/~dimitri/doxygen/doxywizard_usage.html

Or go to the Doxygen Manual for information at the website noted below.

Windows
=======
Go to the following website for the correct download and follow the wizard to install:
http://www.stack.nl/~dimitri/doxygen/download.html

Run the wizard to generate the documentation. 
Go to the website below or the Doxygen Manual for information on running doxywizard.
http://www.stack.nl/~dimitri/doxygen/doxywizard_usage.html

Doxygen Manual
==============
http://www.stack.nl/~dimitri/doxygen/