From 95a1cccf9050cb464cff97dabeb64ea528fb7f3e Mon Sep 17 00:00:00 2001 From: Felix Ruess Date: Thu, 30 Oct 2014 15:45:05 +0100 Subject: [PATCH] dox fixes --- Doxyfile | 2 +- README.md | 2 ++ sw/airborne/arch/sim/subsystems/radio_control/spektrum_arch.c | 2 +- sw/airborne/firmwares/fixedwing/main_chibios_libopencm3.c | 2 +- sw/airborne/modules/digital_cam/catia/README.md | 4 +++- sw/airborne/modules/digital_cam/uart_cam_ctrl.c | 2 +- sw/airborne/modules/digital_cam/uart_cam_ctrl.h | 2 +- sw/airborne/subsystems/datalink/README.md | 4 +++- 8 files changed, 13 insertions(+), 7 deletions(-) diff --git a/Doxyfile b/Doxyfile index 5f0fdc49e0..0cabeb0759 100644 --- a/Doxyfile +++ b/Doxyfile @@ -655,7 +655,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = doc/manual \ +INPUT = README.md doc/manual \ sw/airborne # This tag can be used to specify the character encoding of the source files diff --git a/README.md b/README.md index 397f3fbc80..03706c808d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# MAIN README + Paparazzi UAS ============= diff --git a/sw/airborne/arch/sim/subsystems/radio_control/spektrum_arch.c b/sw/airborne/arch/sim/subsystems/radio_control/spektrum_arch.c index 19304f2eba..047985b919 100644 --- a/sw/airborne/arch/sim/subsystems/radio_control/spektrum_arch.c +++ b/sw/airborne/arch/sim/subsystems/radio_control/spektrum_arch.c @@ -20,7 +20,7 @@ */ /** - * @file arch/sim/spektrum_arch.c + * @file arch/sim/subsystems/radio_control/spektrum_arch.c * * Simulator implementation for spektrum radio control. * diff --git a/sw/airborne/firmwares/fixedwing/main_chibios_libopencm3.c b/sw/airborne/firmwares/fixedwing/main_chibios_libopencm3.c index 241a8471e1..f3e879d44e 100644 --- a/sw/airborne/firmwares/fixedwing/main_chibios_libopencm3.c +++ b/sw/airborne/firmwares/fixedwing/main_chibios_libopencm3.c @@ -20,7 +20,7 @@ */ /** - * @file firmwares/fixedwing/main_chibios.c + * @file firmwares/fixedwing/main_chibios_libopencm3.c */ #include "firmwares/fixedwing/chibios-libopencm3/chibios_init.h" diff --git a/sw/airborne/modules/digital_cam/catia/README.md b/sw/airborne/modules/digital_cam/catia/README.md index 47ba57f30b..57465c0c1c 100644 --- a/sw/airborne/modules/digital_cam/catia/README.md +++ b/sw/airborne/modules/digital_cam/catia/README.md @@ -1,5 +1,7 @@ # CATIA -**C** amera **A** application **T** triggering **I** mage **A** nalysis +**C**amera **A**application **T**triggering **I**mage **A**nalysis Application to capture camera images, store GPS and attitude information, trigger the processing of the image and return the results. + +Sources in `sw/airborne/modules/digital_cam/catia`. diff --git a/sw/airborne/modules/digital_cam/uart_cam_ctrl.c b/sw/airborne/modules/digital_cam/uart_cam_ctrl.c index 862860886c..dc53aadd49 100644 --- a/sw/airborne/modules/digital_cam/uart_cam_ctrl.c +++ b/sw/airborne/modules/digital_cam/uart_cam_ctrl.c @@ -20,7 +20,7 @@ */ /** - * @file modules/digital_cam/digital_cam_uart.c + * @file modules/digital_cam/uart_cam_ctrl.c * Control the camera via uart to chdk-ptp. * Retrieve thumbnails */ diff --git a/sw/airborne/modules/digital_cam/uart_cam_ctrl.h b/sw/airborne/modules/digital_cam/uart_cam_ctrl.h index a6f809c02d..d345812343 100644 --- a/sw/airborne/modules/digital_cam/uart_cam_ctrl.h +++ b/sw/airborne/modules/digital_cam/uart_cam_ctrl.h @@ -19,7 +19,7 @@ * Boston, MA 02111-1307, USA. */ -/** @file modules/digital_cam/digital_cam_uart.h +/** @file modules/digital_cam/uart_cam_ctrl.h * @brief Digital Camera Control Over UART with download of thumbnails over the PAYLOAD message * * Provides the control of a camera over serial, typically connected to a computer which has diff --git a/sw/airborne/subsystems/datalink/README.md b/sw/airborne/subsystems/datalink/README.md index bb071958eb..d850373558 100644 --- a/sw/airborne/subsystems/datalink/README.md +++ b/sw/airborne/subsystems/datalink/README.md @@ -1,10 +1,12 @@ +# Datalink library + Datalink (uplink and downlink) lib using PPRZ protocol ====================================================== HOWTO export ------------ -- Export library: in this folder, type +- Export library: in this folder (`sw/airborne/subsystems/datalink`), type ~~~ make export_lib ~~~