dox fixes

fvantienen · Oct 30, 2014 · 95a1ccc · 95a1ccc
1 parent 9d89f20
commit 95a1ccc
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 7 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
   ~~~
-Original file line number
+Diff line change
@@ Expand Up / @@ -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.
      *
@@ Expand Down @@