documentation.dox 1.43 KB
Newer Older
lm's avatar
lm committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
/**
 * @file
 *   @brief MAVLink communication protocol
 *
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
 *
 */


/** 
 * @mainpage MAVLink API Documentation
 * 
 * @section intro_sec Introduction
 * 
 * This <a href="http://en.wikipedia.org/wiki/API" target="_blank">API</a> documentation covers the MAVLink
 * protocol developed <a href="http://pixhawk.ethz.ch" target="_blank">PIXHAWK</a> project.
 * In case you have generated this documentation locally, the most recent version (generated on every commit)
 * is also publicly available on the internet.
 *
 * @sa http://pixhawk.ethz.ch/api/qgroundcontrol/ - Groundstation code base
 * @sa http://pixhawk.ethz.ch/api/mavlink - (this) MAVLink communication protocol
 * @sa http://pixhawk.ethz.ch/api/imu_autopilot/ - Flight board (ARM MCU) code base
 * @sa http://pixhawk.ethz.ch/api/ai_vision - Computer Vision / AI API docs
 *
 * @section further_sec Further Information
 *
 * How to run our software and a general overview of the software architecture is documented in the project
 * wiki pages.
 *
 * @sa http://pixhawk.ethz.ch/software/mavlink/ - MAVLink main documentation
 *
 * See the <a href="http://pixhawk.ethz.ch" target="_blank">PIXHAWK website</a> for more information.
 * 
 * @section usage_sec Doxygen Usage
 *
 * You can exclude files from being parsed into this Doxygen documentation 
 * by adding them to the EXCLUDE list in the file in embedded/cmake/doc/api/doxy.config.in.
 *
 *
 *
 **/