[doc] some module description cleanups

paparazzi · Dec 29, 2012 · e04623c · e04623c
1 parent d0659d1
commit e04623c
Show file tree

Hide file tree

Showing 49 changed files with 133 additions and 172 deletions.
diff --git a/conf/modules/AOA_adc.xml b/conf/modules/AOA_adc.xml
@@ -1,9 +1,5 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     Angle of Attack ADC module
-     -->
-
 <module name="AOA_adc" dir="sensors">
   <doc>
     <description>Angle of Attack using internal ADC</description>

diff --git a/conf/modules/adc_generic.xml b/conf/modules/adc_generic.xml
@@ -1,11 +1,5 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     Generic ADC module
-     @configure ADC_CHANNEL_GENERIC1 on which ADC input 1 is measured
-     @configure ADC_CHANNEL_GENERIC2 on which ADC input 2 is measured
-     -->
-
 <module name="adc_generic" dir="adcs">
   <doc>
     <description>Generic ADC</description>

diff --git a/conf/modules/airspeed_adc.xml b/conf/modules/airspeed_adc.xml
@@ -1,19 +1,12 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     Airspeed ADC module
-     @configure ADC_AIRSPEED on which ADC the sensor is connected
-     @define AIRSPEED_SCALE/AIRSPEED_QUADRATIC_SCALE scale factor, quadratic is used if defined
-     @define AIRSPEED_BIAS offset on ADC
-     -->
-
 <module name="airspeed_adc" dir="sensors">
   <doc>
-    <description>Airspeed sensor using internal ADC</description>
+    <description>Airspeed sensor (ADC). Using the internal ADC.</description>
     <configure name="ADC_AIRSPEED" value="ADCX" description="ADC on which sensor is connected"/>
     <define name="AIRSPEED_SCALE" value="scale factor" description="linear scale factor (used if AIRSPEED_QUADRATIC_SCALE is not defined"/>
     <define name="AIRSPEED_QUADRATIC_SCALE" value="quadratic scale factor" description="it is recommended to use quadratic scale"/>
-    <define name="AIRSPEED_BIAS" value="sensor bias"/>
+    <define name="AIRSPEED_BIAS" value="sensor bias" description="offset on ADC"/>
   </doc>
 
   <header>

diff --git a/conf/modules/airspeed_ads1114.xml b/conf/modules/airspeed_ads1114.xml
@@ -1,9 +1,11 @@
 <!DOCTYPE module SYSTEM "module.dtd">
-<!-- Module to extend the baro_board module with an airspeed sensor using ads1114 adc -->
 
 <module name="airspeed_ads1114" dir="sensors">
   <doc>
-    <description>Module to extend the baro_board module with an airspeed sensor using ads1114 adc</description>
+    <description>
+      ADS1114 airspeed sensor.
+      Module to extend the baro_board module with an airspeed sensor using ads1114 adc
+    </description>
   </doc>
   <depend require="baro_board.xml"/>
   <header>

diff --git a/conf/modules/airspeed_amsys.xml b/conf/modules/airspeed_amsys.xml
@@ -1,20 +1,15 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-Airspeed AMSYS module (I2C)
-@param AIRSPEED_AMSYS_SCALE scale factor (default 1.8)
-@param AIRSPEED_AMSYS_OFFSET offset (default 0)
-@param AIRSPEED_AMSYS_I2C_DEV i2c device (default i2c0)
-@flag USE_AIRSPEED to use the data for airspeed control loop
-@flag SENSOR_SYNC_SEND to transmit the data as it is acquired
--->
-
 <module name="airspeed_amsys" dir="sensors">
   <doc>
-    <description>Airspeed AMSYS module (I2C)</description>
-    <define name="AIRSPEED_AMSYS_I2C_DEV" value="i2cX" description="change default i2c peripheral"/>
-    <define name="AIRSPEED_AMSYS_OFFSET" value="sensor offset"/>
-    <define name="AIRSPEED_AMSYS_SCALE" value="sensor scale factor"/>
+    <description>
+      Airspeed AMSYS (I2C)
+      Driver for a Amsys Differential Presure Sensor I2C
+      (AMS 5812-0003-D)
+    </description>
+    <define name="AIRSPEED_AMSYS_I2C_DEV" value="i2c0" description="change default i2c peripheral"/>
+    <define name="AIRSPEED_AMSYS_OFFSET" value="0" description="sensor offset (default: 0)"/>
+    <define name="AIRSPEED_AMSYS_SCALE" value="1.0" description="sensor scale factor (default: 1.0)"/>
     <define name="USE_AIRSPEED" description="flag to use the data for airspeed control"/>
     <define name="SENSOR_SYNC_SEND" description="flag to transmit the data as it is acquired"/>
   </doc>

diff --git a/conf/modules/airspeed_ets.xml b/conf/modules/airspeed_ets.xml
@@ -1,20 +1,25 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     Airspeed ETS module (I2C)
-     @define AIRSPEED_ETS_SCALE scale factor (default 1.8)
-     @define AIRSPEED_ETS_OFFSET offset (default 0)
-     @define AIRSPEED_ETS_I2C_DEV i2c device (default i2c0)
-     @define USE_AIRSPEED to use the data for airspeed control loop
-     @define SENSOR_SYNC_SEND to transmit the data as it is acquired
-     -->
-
 <module name="airspeed_ets" dir="sensors">
   <doc>
-    <description>Airspeed ETS module (I2C)</description>
-    <define name="AIRSPEED_ETS_I2C_DEV" value="i2cX" description="change default i2c peripheral"/>
-    <define name="AIRSPEED_ETS_OFFSET" value="sensor offset"/>
-    <define name="AIRSPEED_ETS_SCALE" value="sensor scale factor"/>
+    <description>
+      Airspeed ETS (I2C).
+      Driver for the EagleTree Systems Airspeed Sensor.
+      Has only been tested with V3 of the sensor hardware.
+
+      Notes:
+      Connect directly to TWOG/Tiny I2C port. Multiple sensors can be chained together.
+      Sensor should be in the proprietary mode (default) and not in 3rd party mode.
+
+      Sensor module wire assignments:
+      - Red wire: 5V
+      - White wire: Ground
+      - Yellow wire: SDA
+      - Brown wire: SCL
+    </description>
+    <define name="AIRSPEED_ETS_I2C_DEV" value="i2c0" description="change default i2c peripheral"/>
+    <define name="AIRSPEED_ETS_OFFSET" value="0" description="sensor offset (default: 0)"/>
+    <define name="AIRSPEED_ETS_SCALE" value="1.8" description="sensor scale factor (default: 1.8)"/>
     <define name="USE_AIRSPEED" description="flag to use the data for airspeed control"/>
     <define name="SENSOR_SYNC_SEND" description="flag to transmit the data as it is acquired"/>
   </doc>

diff --git a/conf/modules/alt_filter.xml b/conf/modules/alt_filter.xml
@@ -2,7 +2,10 @@
 
 <module name="alt_filter" dir="ins">
   <doc>
-    <description>Altitude filter (not used for A/C estimation and control, only debug)</description>
+    <description>
+      Altitude filter
+      (not used for A/C estimation and control, only debug)
+    </description>
   </doc>
   <header>
     <file name="alt_filter.h"/>

diff --git a/conf/modules/alt_srf08.xml b/conf/modules/alt_srf08.xml
@@ -2,7 +2,7 @@
 
 <module name="alt_srf08" dir="sensors">
   <doc>
-    <description>Range meter based on srf08 ultrasonic sensor</description>
+    <description>SRF08 ultrasonic range meter</description>
   </doc>
   <header>
     <file name="alt_srf08.h"/>

diff --git a/conf/modules/baro_amsys.xml b/conf/modules/baro_amsys.xml
@@ -1,13 +1,8 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     Baro ETS module (I2C)
-     @param BARO_ETS_I2C_DEV i2c device (default i2c0)
-     -->
-
 <module name="baro_amsys" dir="sensors">
   <doc>
-    <description>Baro ETS module (I2C)</description>
+    <description>Baro ETS (I2C)</description>
     <define name="BARO_ETS_I2C_DEV" value="i2cX" description="select which i2c peripheral to use (default i2c0)"/>
   </doc>
 

diff --git a/conf/modules/baro_bmp.xml b/conf/modules/baro_bmp.xml
@@ -1,11 +1,5 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     Bosch BMP085 pressure sensor
-     @define BMP_I2C_DEV i2c device (default i2c0)
-     @define SENSOR_SYNC_SEND to transmit the data as it is acquired
-     -->
-
 <module name="baro_bmp" dir="sensors">
   <doc>
     <description>Bosch BMP085 pressure sensor</description>

diff --git a/conf/modules/baro_board.xml b/conf/modules/baro_board.xml
@@ -2,7 +2,10 @@
 
 <module name="baro_board" dir="sensors">
   <doc>
-    <description>Allow to use baro interface on fixedwing with external barometers</description>
+    <description>
+      Baro board wrapper.
+      Allows to use baro interface on fixedwing with external barometers.
+    </description>
   </doc>
   <header>
     <file name="baro_board_module.h"/>

diff --git a/conf/modules/baro_ets.xml b/conf/modules/baro_ets.xml
@@ -1,13 +1,8 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     Baro ETS module (I2C)
-     @define BARO_ETS_I2C_DEV i2c device (default i2c0)
-     -->
-
 <module name="baro_ets" dir="sensors">
   <doc>
-    <description>Baro ETS module (I2C)</description>
+    <description>Baro ETS (I2C)</description>
     <define name="BARO_ETS_I2C_DEV" value="i2cX" description="select i2c peripheral to use (default i2c0)"/>
     <define name="BARO_ETS_SCALE" value="sensor scale factor"/>
     <define name="BARO_ETS_TELEMETRY" description="flag to transmit the data as it is acquired"/>

diff --git a/conf/modules/baro_hca.xml b/conf/modules/baro_hca.xml
@@ -2,7 +2,7 @@
 
 <module name="baro_hca" dir="sensors">
   <doc>
-    <description>Baro sensortechnics HCA module (I2C)</description>
+    <description>Baro sensortechnics HCA (I2C)</description>
     <define name="BARO_HCA_I2C_DEV" value="i2cX" description="select which i2c peripheral to use (default i2c0)"/>
   </doc>
 

diff --git a/conf/modules/baro_mpl3115.xml b/conf/modules/baro_mpl3115.xml
@@ -2,7 +2,7 @@
 
 <module name="baro_mpl3115" dir="sensors">
   <doc>
-    <description>Baro MPL3115A2 module (I2C)</description>
+    <description>Baro MPL3115A2 (I2C)</description>
     <define name="MPL3115_I2C_DEV" value="i2cX" description="select which i2c peripheral to use (default i2c0)"/>
   </doc>
 

diff --git a/conf/modules/baro_ms5611_i2c.xml b/conf/modules/baro_ms5611_i2c.xml
@@ -1,13 +1,11 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     Measurement Specialties MS5611-01BA pressure sensor (I2C)
-     @param MS5611_I2C_DEV i2c device (default i2c0)
-     -->
-
 <module name="baro_ms5611_i2c" dir="sensors">
   <doc>
-    <description>Measurement Specialties MS5611-01BA pressure sensor (I2C)</description>
+    <description>
+      Baro MS5611 (I2C)
+      Measurement Specialties MS5611-01BA pressure sensor (I2C)
+    </description>
     <define name="MS5611_I2C_DEV" value="i2cX" description="select i2c peripheral to use (default i2c0)"/>
   </doc>
   <header>

diff --git a/conf/modules/baro_scp.xml b/conf/modules/baro_scp.xml
@@ -1,10 +1,5 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     VTI SCP1000 pressure sensor (SPI)
-     @define SENSOR_SYNC_SEND to transmit the data as it is acquired
-     -->
-
 <module name="baro_scp" dir="sensors">
   <doc>
     <description>VTI SCP1000 pressure sensor (SPI)</description>

diff --git a/conf/modules/baro_scp_i2c.xml b/conf/modules/baro_scp_i2c.xml
@@ -1,11 +1,5 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     VTI SCP1000 pressure sensor (I2C)
-     @define SCP_I2C_DEV i2c device (default i2c0)
-     @define SENSOR_SYNC_SEND to transmit the data as it is acquired
-     -->
-
 <module name="baro_scp_i2c" dir="sensors">
   <doc>
     <description>VTI SCP1000 pressure sensor (I2C)</description>

diff --git a/conf/modules/bat_checker.xml b/conf/modules/bat_checker.xml
@@ -1,12 +1,5 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     Battery checker module
-     @define BAT_CHECKER_DELAY Number of seconds the battery voltage has to be
-                               below LOW_BAT_LEVEL before the warning signal is
-                               activated.
-     @define BAT_CHECKER_LED   The LED to use for the warning signal.
-     -->
 <module name="bat_checker">
   <doc>
     <description>Battery checker module</description>

diff --git a/conf/modules/charge_sens.xml b/conf/modules/charge_sens.xml
@@ -2,7 +2,10 @@
 
 <module name="charge_sens" dir="meteo">
   <doc>
-    <description></description>
+    <description>
+      Charge sensor.
+      I2C interface for University of Reading charge sensor
+    </description>
   </doc>
   <header>
     <file name="charge_sens.h"/>

diff --git a/conf/modules/deploy_sonar_buoy.xml b/conf/modules/deploy_sonar_buoy.xml
@@ -2,7 +2,10 @@
 
 <module name="deploy_sonar_buoy">
   <doc>
-    <description></description>
+    <description>
+      Toggle two gpio pins (Lisa).
+      The application in this was written for drops two sonar buoys.
+    </description>
   </doc>
   <header>
     <file name="deploy_sonar_buoy.h"/>

diff --git a/conf/modules/digital_cam_i2c.xml b/conf/modules/digital_cam_i2c.xml
@@ -2,7 +2,10 @@
 
 <module name="atmega_i2c_cam_ctrl" dir="digital_cam">
   <doc>
-    <description>Trigger Digital Camera Using I2C connected remote microcontroller</description>
+    <description>
+      Trigger Digital Camera (I2C).
+      Using I2C connected remote microcontroller
+    </description>
     <define name="DC_SHOOT_ON_BUTTON_RELEASE" />
     <define name="SENSOR_SYNC_SEND" value="1" />
   </doc>

diff --git a/conf/modules/dust_gp2y.xml b/conf/modules/dust_gp2y.xml
@@ -2,7 +2,11 @@
 
 <module name="dust_gp2y" dir="meteo">
   <doc>
-    <description></description>
+    <description>
+      Sharp GP2Y1010AU dust sensor.
+      This reads the values for dust density from the Sharp GP2Y1010AU0F sensor
+      through I2C (needs I2C ADC at the sensor).
+    </description>
   </doc>
   <header>
     <file name="dust_gp2y.h"/>

diff --git a/conf/modules/ezcurrent.xml b/conf/modules/ezcurrent.xml
@@ -1,9 +1,5 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!--
-     EzOSD current sensor module (I2C)
--->
-
 <module name="ezcurrent" dir="sensors">
   <doc>
     <description>EzOSD Current sensor (I2C).</description>

diff --git a/conf/modules/gain_scheduling.xml b/conf/modules/gain_scheduling.xml
@@ -2,7 +2,10 @@
 
 <module name="gain_scheduling">
   <doc>
-    <description> Module that interpolates between different gain sets </description>
+    <description>
+      Gain set interpolation.
+      Interpolate between different gain sets for rotorcrafts.
+    </description>
   </doc>
   <header>
     <file name="gain_scheduling.h"/>

diff --git a/conf/modules/geiger_counter.xml b/conf/modules/geiger_counter.xml
@@ -2,7 +2,7 @@
 
 <module name="geiger_counter" dir="meteo">
   <doc>
-    <description>Geifer counter sensor</description>
+    <description>Geiger counter sensor</description>
   </doc>
   <header>
     <file name="geiger_counter.h"/>

diff --git a/conf/modules/generic_com.xml b/conf/modules/generic_com.xml
@@ -1,13 +1,11 @@
 <!DOCTYPE module SYSTEM "module.dtd">
-<!-- Generic Com Module -->
-<!-- Can be redefined :
-     GENERIC_COM_I2C_DEV (default: i2c0)
-     GENERIC_COM_SLAVE_ADDR (default: ??)
-     -->
 
 <module name="generic_com" dir="com">
   <doc>
-    <description>Generic com (can be used for Satcom/GSM)</description>
+    <description>
+      Generic com.
+      Can be used for Satcom/GSM
+    </description>
     <define name="GENERIC_COM_I2C_DEV" value="i2cX" description="select i2c peripheral to use (default i2c0)"/>
     <define name="GENERIC_COM_SLAVE_ADDR" value="i2c address"/>
   </doc>

diff --git a/conf/modules/gps_i2c.xml b/conf/modules/gps_i2c.xml
@@ -1,13 +1,11 @@
 <!DOCTYPE module SYSTEM "module.dtd">
 
-<!-- to be configured with
-ap.CFLAGS += -DUSE_GPS -DUBX -DGPS_LINK=gps_i2c -DGPS_LED=2
-ap.CFLAGS += -DGPS_CONFIGURE -DGPS_PORT_ID=GPS_PORT_DDC
--->
-
 <module name="gps_i2c">
   <doc>
-    <description>U-blox gps using i2c (broken)</description>
+    <description>
+      U-blox GPS (I2C)
+      (apparently currently broken)
+    </description>
   </doc>
   <header>
     <file name="gps_i2c.h"/>
@@ -18,7 +16,7 @@ ap.CFLAGS += -DGPS_CONFIGURE -DGPS_PORT_ID=GPS_PORT_DDC
   <makefile target="ap">
     <file name="gps_i2c.c"/>
     <define name="GPS_CONFIGURE" />
-    <define name="GPS_PORT_ID" value="GPS_PORT_DDC" />
+    <define name="GPS_PORT_ID" value="GPS_PORT_DDC"/>
   </makefile>
 </module>