[dox] fix some doxygen file blocks for fixedwing firmware

2026-06-06 07:53:43 +08:00 · 2013-01-16 16:49:40 +01:00
parent 961f662a75
commit 49f28d4529
15 changed files with 36 additions and 34 deletions
@@ -17,11 +17,12 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

-/** \file ap_downlink.h
- *  \brief Set of macros defining the periodic telemetry messages of AP process
+/**
+ * @file firmwares/fixedwing/ap_downlink.h
+ *
+ * Set of macros defining the periodic telemetry messages of AP process.
 *
 * The PeriodicSendAp() macro is generated from the telemetry description
 * (named in conf.xml, usually in conf/telemetry directory). This macro
@@ -17,13 +17,12 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

 /**
 * @file firmwares/fixedwing/autopilot.c
 *
- * Autopilot inititalization.
+ * Fixedwing autopilot inititalization.
 *
 */

@@ -17,13 +17,12 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

 /**
 * @file firmwares/fixedwing/autopilot.h
 *
- * Autopilot modes.
+ * Fixedwing autopilot modes.
 *
 */

@@ -17,7 +17,6 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

 /**
@@ -17,11 +17,12 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

-/** \file fbw_downlink.h
- *  \brief Set of macros defining the periodic telemetry messages of FBW process
+/**
+ * @file firmwares/fixedwing/fbw_downlink.h
+ *
+ * Set of macros defining the periodic telemetry messages of FBW process.
 *
 * The PeriodicSendAp() macro is generated from the telemetry description
 * (named in conf.xml, usually in conf/telemetry directory). This macro
@@ -20,7 +20,7 @@
 */

 /**
- * @file firmwares/fixedwing/guidance/guidance_v.h
+ * @file firmwares/fixedwing/guidance/guidance_common.h
 * Vertical control for fixed wing vehicles.
 *
 */
@@ -17,7 +17,6 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

 /**
@@ -17,15 +17,15 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

 /**
- * @file main_ap.c
+ * @file firmwares/fixedwing/main_ap.c
+ *
 * AP ( AutoPilot ) tasks
 *
- * This process is reponsible for the collecting the different sensors data, fusing them to obtain
- * aircraft attitude and running the different control loops
+ * This process is reponsible for the collecting the different sensors data,
+ * calling the appropriate estimation algorithms and running the different control loops.
 */

 #define MODULES_C
@@ -17,11 +17,12 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

-/** \file main_ap.h
- *  \brief AP ( AutoPilot ) process API
+/**
+ * @file firmwares/fixedwing/main_ap.h
+ *
+ * AP ( AutoPilot ) process API
 *
 */

@@ -20,10 +20,12 @@
 *
 */

-/** \file main_fbw.c
- *  \brief FBW ( FlyByWire ) process
+/**
+ * @file firmwares/fixedwing/main_fbw.c
 *
- *   This process is responsible for decoding radio control, generating actuators
+ * FBW ( FlyByWire ) process
+ *
+ * This process is responsible for decoding radio control, generating actuators
 * signals either from the radio control or from the commands provided by the
 * AP (autopilot) process. It also performs a telemetry task and a low level monitoring
 * ( for parameters like the supply )
@@ -17,11 +17,12 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

-/** @file main_fbw.h
- *  @brief FBW ( FlyByWire ) process API
+/**
+ * @file firmwares/fixedwing/main_fbw.h
+ *
+ * FBW ( FlyByWire ) process API
 *
 */

@@ -17,12 +17,12 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

 /**
+ * @file firmwares/fixedwing/stabilization/stabilization_adaptive.c
 *
- * fixed wing horizontal adaptive control
+ * Fixed wing horizontal adaptive control.
 *
 */

@@ -17,12 +17,12 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

 /**
+ * @file firmwares/fixedwing/stabilization/stabilization_adaptive.h
 *
- * fixed wing horizontal adaptive control
+ * Fixed wing horizontal adaptive control.
 *
 */

@@ -17,12 +17,12 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

 /**
+ * @file firmwares/fixedwing/stabilization/stabilization_attitude.c
 *
- * fixed wing horizontal control
+ * Fixed wing horizontal control.
 *
 */

@@ -17,12 +17,12 @@
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
- *
 */

 /**
+ * @file firmwares/fixedwing/stabilization/stabilization_attitude.h
 *
- * fixed wing horizontal control
+ * Fixed wing horizontal control.
 *
 */