[modules] dox updates for qnh

paparazzi · Oct 6, 2014 · d904173 · d904173
1 parent 2b23a07
commit d904173
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 15 deletions.
diff --git a/sw/airborne/modules/altitude/qnh.c b/sw/airborne/modules/altitude/qnh.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2014 CDW
+ * Copyright (C) 2014 Christophe De Wagter
  *
  * This file is part of paparazzi.
  *
@@ -14,9 +14,13 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * 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.
+ * along with paparazzi; see the file COPYING.  If not, see
+ * <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @file qnh.c
+ * QNH module.
  *
  */
 

diff --git a/sw/airborne/modules/altitude/qnh.h b/sw/airborne/modules/altitude/qnh.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2014 CDW
+ * Copyright (C) 2014 Christophe De Wagter
  *
  * This file is part of paparazzi.
  *
@@ -14,26 +14,25 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * 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.
- *
+ * along with paparazzi; see the file COPYING.  If not, see
+ * <http://www.gnu.org/licenses/>.
  */
 
-/** \file qnh_module.h
+/**
+ * @file qnh.h
+ * QNH module.
  *
- * qnh module
  */
 
 #ifndef QNH_MODULE_H
 #define QNH_MODULE_H
 
 struct qnh_struct
 {
-  float qnh;
-  float amsl_baro;
-  float amsl_gps;
-  float baro_pressure;
+  float qnh;           ///< Barometric pressure adjusted to sea level in Pa
+  float amsl_baro;     ///< AMSL (Altitude AboveMeanSeaLevel) from baro in feet
+  float amsl_gps;      ///< AMSL (Altitude AboveMeanSeaLevel) from GPS in feet
+  float baro_pressure; ///< Pressure reported by baro in Pa
   int baro_counter;
 };