From cb6facbb75460a96c74a542992e2cde70b5fd283 Mon Sep 17 00:00:00 2001
From: Felix Ruess <felix.ruess@gmail.com>
Date: Sat, 15 Dec 2012 21:21:57 +0100
Subject: [PATCH] [conf][doc] prepare for autogeneration of module docs move
 defines where the values need escaping to the raw makefile section this
 specific escape code doesn't work with all parsers...

---
 .gitignore                           |  1 +
 Doxyfile                             |  4 ++--
 conf/modules/ahrs_chimu_spi.xml      |  4 ++--
 conf/modules/ahrs_chimu_uart.xml     |  4 ++--
 conf/modules/gps_ubx_uart.xml        |  9 +++++++--
 conf/modules/gps_ubx_ucenter.xml     | 21 ++++-----------------
 conf/modules/sonar_maxbotix_booz.xml |  9 +--------
 conf/modules/xtend_rssi.xml          | 17 ++++++-----------
 doc/manual/mainpage.dox              |  2 ++
 9 files changed, 27 insertions(+), 44 deletions(-)

diff --git a/.gitignore b/.gitignore
index 5ea8fce35a2..f70849d5ab3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,6 @@
 # ignore html dir for github pages
 /doc/generated
+/doc/manual/generated
 
 *.so
 *.[oa]
diff --git a/Doxyfile b/Doxyfile
index f8cc20f752e..12fb2c9aa50 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -682,14 +682,14 @@ EXCLUDE_SYMBOLS        =
 # directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = conf/modules
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
 # and *.h) to filter out the source-files in the directories. If left
 # blank all files are included.
 
-EXAMPLE_PATTERNS       =
+EXAMPLE_PATTERNS       = *.xml
 
 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
 # searched for input files to be used with the \include or \dontinclude
diff --git a/conf/modules/ahrs_chimu_spi.xml b/conf/modules/ahrs_chimu_spi.xml
index 835ddb5d550..4fc6b43bb5a 100644
--- a/conf/modules/ahrs_chimu_spi.xml
+++ b/conf/modules/ahrs_chimu_spi.xml
@@ -10,7 +10,6 @@
   </header>
   <event fun="parse_ins_msg()"/>
   <makefile target="ap">
-    <define name="AHRS_TYPE_H" value="\\\"modules/ins/ins_module.h\\\""/>
     <define name="AHRS_TRIGGERED_ATTITUDE_LOOP"/>
     <define name="USE_AHRS"/>
     <define name="USE_INS_MODULE"/>
@@ -19,8 +18,9 @@
     <define name="USE_USB_HIGH_PCLK" />
     <file name="ahrs_chimu_spi.c"/>
     <file name="imu_chimu.c"/>
+    <file name="ahrs.c" dir="subsystems"/>
     <raw>
-      ap.srcs += subsystems/ahrs.c
+      ap.CFLAGS += -DAHRS_TYPE_H=\"modules/ins/ins_module.h\"
     </raw>
   </makefile>
 </module>
diff --git a/conf/modules/ahrs_chimu_uart.xml b/conf/modules/ahrs_chimu_uart.xml
index 1780c695479..da0fd204b65 100644
--- a/conf/modules/ahrs_chimu_uart.xml
+++ b/conf/modules/ahrs_chimu_uart.xml
@@ -14,7 +14,6 @@
   <!--<periodic fun="ins_periodic()" freq="60"/>-->
   <event fun="parse_ins_msg()"/>
   <makefile target="ap">
-    <define name="AHRS_TYPE_H" value="\\\"modules/ins/ins_module.h\\\""/>
     <define name="AHRS_TRIGGERED_ATTITUDE_LOOP"/>
     <define name="USE_AHRS"/>
     <define name="USE_INS_MODULE"/>
@@ -23,8 +22,9 @@
     <define name="UART$(CHIMU_UART_NR)_BAUD" value="B115200"/>
     <file name="ahrs_chimu_uart.c"/>
     <file name="imu_chimu.c"/>
+    <file name="ahrs.c" dir="subsystems"/>
     <raw>
-      ap.srcs += subsystems/ahrs.c
+      ap.CFLAGS += -DAHRS_TYPE_H=\"modules/ins/ins_module.h\"
     </raw>
   </makefile>
 </module>
diff --git a/conf/modules/gps_ubx_uart.xml b/conf/modules/gps_ubx_uart.xml
index 6804219f374..f6f7df1ba57 100644
--- a/conf/modules/gps_ubx_uart.xml
+++ b/conf/modules/gps_ubx_uart.xml
@@ -14,11 +14,16 @@
   </makefile>
   <makefile target="ap">
     <file name="gps_ubx.c" dir="subsystems/gps"/>
-    <define name="GPS_TYPE_H" value="\"subsystems/gps/gps_ubx.h\""/>
+    <raw>
+      ap.CFLAGS += -DGPS_TYPE_H=\"subsystems/gps/gps_ubx.h\"
+    </raw>
   </makefile>
   <makefile target="sim|jsbsim">
     <file name="gps_sim.c" dir="subsystems/gps"/>
-    <define name="GPS_TYPE_H" value="\"subsystems/gps/gps_sim.h\""/>
+    <raw>
+      sim.CFLAGS += -DGPS_TYPE_H=\"subsystems/gps/gps_sim.h\"
+      jsbsim.CFLAGS += -DGPS_TYPE_H=\"subsystems/gps/gps_sim.h\"
+    </raw>
   </makefile>
 </module>
 
diff --git a/conf/modules/gps_ubx_ucenter.xml b/conf/modules/gps_ubx_ucenter.xml
index 2b3fb90a88c..d03d8319873 100644
--- a/conf/modules/gps_ubx_ucenter.xml
+++ b/conf/modules/gps_ubx_ucenter.xml
@@ -1,24 +1,9 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-
-	Automatically configure any Ublox GPS for paparazzi
-
-	-configures all the messages, and the rates
-	-automatic baudrate detection
-
-	Warning: you still need to tell the driver
-	a) which paparazzi uart you use
-	b) inside the ublox gps there are also many ports. the tiny/ppzgps use ublox_internal_port1 but if for instance you use a LS-SAM or I2C device you need to configure:
-
-	<define name="GPS_PORT_ID" value="GPS_PORT_UART2" />
-
--->
-
 <module name="gps_ubx" dir="gps">
   <doc>
     <description>
-      Automatically configure any Ublox GPS for paparazzi
+      Automatically configure any Ublox GPS for paparazzi.
 
       -configures all the messages, and the rates
       -automatic baudrate detection
@@ -35,7 +20,9 @@
   <init fun="gps_ubx_ucenter_init()"/>
   <periodic fun="gps_ubx_ucenter_periodic()" start="gps_ubx_ucenter_init()" freq="4." autorun="TRUE"/>
   <makefile target="ap">
-    <define name="GPS_UBX_UCENTER" value="\\\"modules/gps/gps_ubx_ucenter.c\\\"" />
+    <raw>
+      ap.CFLAGS += -DGPS_UBX_UCENTER=\"modules/gps/gps_ubx_ucenter.c\"
+    </raw>
   </makefile>
 </module>
 
diff --git a/conf/modules/sonar_maxbotix_booz.xml b/conf/modules/sonar_maxbotix_booz.xml
index 52013c3aa79..653789d22e4 100644
--- a/conf/modules/sonar_maxbotix_booz.xml
+++ b/conf/modules/sonar_maxbotix_booz.xml
@@ -1,12 +1,5 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     Maxbotix Sonar driver
-     @configure ADC_SONAR on which ADC the sensor is connected
-
-     On Booz board, ADC_0 should be use by default (payload connector)
-     -->
-
 <module name="sonar">
   <doc>
     <description>
@@ -17,7 +10,7 @@
   </doc>
   <header>
     <file name="sonar_maxbotix.h"/>
-    <file name="../../subsystems/ins.h"/>
+    <file name="ins.h" dir="subsystems"/>
   </header>
   <init fun="maxbotix_init()"/>
   <periodic fun="maxbotix_read()" freq="10"/>
diff --git a/conf/modules/xtend_rssi.xml b/conf/modules/xtend_rssi.xml
index c76f8358374..d5e532d9c22 100644
--- a/conf/modules/xtend_rssi.xml
+++ b/conf/modules/xtend_rssi.xml
@@ -1,19 +1,14 @@
 <!DOCTYPE module SYSTEM "module.dtd">
-<!-- Currently only available on LPC21xx arch
-    Digi Xtend RSSI PWM Module
-    @configure XTEND_RSSI_PWM_INPUT_CHANNEL on which arch dep input the pwm line is connected
-      For LPC21xx on the TWOG:
-      1 - INPUT CAPTURE CAP0.3 on P0.29 (TWOG ADC5, 5V->3.3V voltage divider)
-      2 - INPUT CAPTURE CAP0.0 on P0.30 (TWOG ADC4, no voltage divider)
--->
+
 <module name="xtend_rssi" dir="datalink">
   <doc>
     <description>
-      Digi Xtend RSSI PWM Module
+      Digi Xtend RSSI PWM Module.
       For LPC21xx on the TWOG:
-      1 - INPUT CAPTURE CAP0.3 on P0.29 (TWOG ADC5, 5V to 3.3V voltage divider)
-      2 - INPUT CAPTURE CAP0.0 on P0.30 (TWOG ADC4, no voltage divider)
-      Currently only available on LPC21xx arch
+      - INPUT CAPTURE CAP0.3 on P0.29 (TWOG ADC5, 5V to 3.3V voltage divider)
+      - INPUT CAPTURE CAP0.0 on P0.30 (TWOG ADC4, no voltage divider)
+
+      Currently only available on LPC21xx arch.
       You must also load the module pwm_meas.xml
     </description>
     <configure name="XTEND_RSSI_PWM_INPUT_CHANNEL" value="input" description="select on which arch dep input the pwm line is connected"/>
diff --git a/doc/manual/mainpage.dox b/doc/manual/mainpage.dox
index 45c4e60b259..cdac928f330 100644
--- a/doc/manual/mainpage.dox
+++ b/doc/manual/mainpage.dox
@@ -12,6 +12,8 @@ sections before starting work:
 @ref primer provide introductory materials for new developers on various
 specific topics.
 
+The @ref onboard_modules page list all available modules.
+
 
  */