zrzk
/
px4_autopilot
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
3360 Commits
14 Branches
0 Tags
306 MiB
 
 
 
 
 
 
Tree: c21ba6c500
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c21ba6c500'
${ noResults }
px4_autopilot/Documentation
Lorenz Meier 525cc1a37c
Added docs 		12 years ago
..
Doxyfile Fresh import of the PX4 firmware sources. 13 years ago
README Fresh import of the PX4 firmware sources. 13 years ago
arming_state_machine.odg Major push in state machine cleanup 12 years ago
arming_state_machine.pdf Major push in state machine cleanup 12 years ago
code_structure_diagrams.odg docu diagrams: removed old inter app communication, updated state machine (is now also in a separate file) 13 years ago
code_structure_diagrams.pdf Fresh import of the PX4 firmware sources. 13 years ago
commander_app.odg made the commander app docu diagram nicer 13 years ago
commander_app.png made the commander app docu diagram nicer 13 years ago
control_flow.graffle Added docs 12 years ago
doxygen.sh Fresh import of the PX4 firmware sources. 13 years ago
flight_mode_state_machine.odg Updated docs 12 years ago
flight_mode_state_machine.pdf Updated docs 12 years ago
position_control.odg added position control documentation diagram 13 years ago
position_control.png added position control documentation diagram 13 years ago
position_estimator_app.odg Fresh import of the PX4 firmware sources. 13 years ago
position_estimator_app.pdf Fresh import of the PX4 firmware sources. 13 years ago
position_estimator_app.png Fresh import of the PX4 firmware sources. 13 years ago
px4_general_structure.png Fresh import of the PX4 firmware sources. 13 years ago
rc_mode_switch.odg Updated state machine docs after first review round 12 years ago
rc_mode_switch.pdf Updated state machine docs after first review round 12 years ago
state_machine.odg docu diagrams: removed old inter app communication, updated state machine (is now also in a separate file) 13 years ago
state_machine.png docu diagrams: removed old inter app communication, updated state machine (is now also in a separate file) 13 years ago
versionfilter.sh Fresh import of the PX4 firmware sources. 13 years ago

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/