[dox] more doxygen file header fixes

This commit is contained in:
Felix Ruess
2012-12-16 17:57:16 +01:00
parent c4415af099
commit e56138cc06
22 changed files with 183 additions and 33 deletions
+4 -2
View File
@@ -20,8 +20,10 @@
* *
*/ */
/** \file baro_MS5534A.h /**
* \brief Handling of the MS5534a pressure sensor * @file arch/sim/baro_MS5534A.h
*
* Dummy Handling of the MS5534a pressure sensor for the sim.
* *
*/ */
@@ -20,7 +20,7 @@
*/ */
/** /**
* @file math/pprz_orienation_conversion.h * @file math/pprz_orientation_conversion.h
* Generic orientation representation and conversions. * Generic orientation representation and conversions.
* *
* This file contains the functions to automatically convert between * This file contains the functions to automatically convert between
+5
View File
@@ -20,6 +20,11 @@
* *
*/ */
/**
* @file modules/MPPT/MPPT.c
* @brief Solar cells MPTT monitoring
*
*/
#include <stdbool.h> #include <stdbool.h>
#include "MPPT.h" #include "MPPT.h"
+3 -2
View File
@@ -20,8 +20,9 @@
* *
*/ */
/** \file MPTT.h /**
* \brief Solar cells MPTT monitoring * @file modules/MPPT/MPPT.h
* @brief Solar cells MPTT monitoring
* *
*/ */
@@ -20,6 +20,18 @@
* *
*/ */
/** @file modules/benchmark/i2c_abuse_test.c
*
* Total I2C Abuse:
*
* -all transaction types: T1 T2 T3 T4 R1 R2 R3 R4 T1R1 T2R1 T1R2 T1R3 T1R4 T1R5 T2R5
* -all bitrates: 1k (way too slow) to 1M (way to fast)
* -occasional Short circuit (simulate bus capacitance or EMI errors)
* -variable bus load: from empty to full stack
*
* -Connect LED to MosFet that pulls-down the SCL and SDA lines
*/
#include "i2c_abuse_test.h" #include "i2c_abuse_test.h"
#include "led.h" #include "led.h"
#include "mcu_periph/i2c.h" #include "mcu_periph/i2c.h"
@@ -20,7 +20,7 @@
* *
*/ */
/** \file I2C_ABUSE_TEST_module.h /** @file modules/benchmark/i2c_abuse_test.h
* *
* Total I2C Abuse: * Total I2C Abuse:
* *
+4 -3
View File
@@ -20,10 +20,11 @@
* *
*/ */
/** \file trigger_ext.c /**
* \brief Measure external trigger pulse at PPM input (default) * @file modules/core/trigger_ext.c
* Measure external trigger pulse at PPM input (default).
* *
* This measures a trigger pulse length * This measures a trigger pulse length
*/ */
+4 -3
View File
@@ -20,10 +20,11 @@
* *
*/ */
/** \file trigger_ext.h /**
* \brief Measure external trigger pulse at PPM input (default) * @file modules/core/trigger_ext.h
* Measure external trigger pulse at PPM input (default).
* *
* This measures a trigger pulse length * This measures a trigger pulse length
*/ */
#ifndef TRIGGER_EXT_H #ifndef TRIGGER_EXT_H
@@ -21,6 +21,13 @@
* Initial author: C. De Wagter * Initial author: C. De Wagter
*/ */
/**
* @file modules/gps/gps_ubx_ucenter.c
* @brief Configure Ublox GPS
*
*/
#include "gps_ubx_ucenter.h" #include "gps_ubx_ucenter.h"
////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////
+2 -1
View File
@@ -19,7 +19,8 @@
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** @file gps_ucenter_onboard.h /**
* @file modules/gps/gps_ubx_ucenter.h
* @brief Configure Ublox GPS * @brief Configure Ublox GPS
* *
*/ */
+25 -2
View File
@@ -1,5 +1,28 @@
/** \file dpicco.c /*
* \brief DigiPicco I2C sensor interface * Copyright (C) 2005-2012 The Paparazzi Team
*
* This file is part of paparazzi.
*
* paparazzi is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* paparazzi is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* 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.
*
*/
/**
* @file modules/meteo/humid_dpicco.c
* @brief DigiPicco I2C sensor interface
* *
* This reads the values for humidity and temperature from the IST DigiPicco sensor through I2C. * This reads the values for humidity and temperature from the IST DigiPicco sensor through I2C.
*/ */
+29
View File
@@ -1,3 +1,32 @@
/*
* Copyright (C) 2005-2012 The Paparazzi Team
*
* This file is part of paparazzi.
*
* paparazzi is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* paparazzi is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* 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.
*
*/
/**
* @file modules/meteo/humid_dpicco.h
* @brief DigiPicco I2C sensor interface
*
* This reads the values for humidity and temperature from the IST DigiPicco sensor through I2C.
*/
#ifndef DPICCO_H #ifndef DPICCO_H
#define DPICCO_H #define DPICCO_H
+5 -4
View File
@@ -20,11 +20,12 @@
* *
*/ */
/** \file humid_pcap01.c /**
* \brief ACAM Picocap Single-chip Solution for Capacitance Measurement * @file modules/meteo/humid_pcap01.c
* @brief ACAM Picocap Single-chip Solution for Capacitance Measurement
* *
* This reads the values for temperature and humidity from the ACAM capacitance and resistance * This reads the values for temperature and humidity from the ACAM capacitance and resistance
* measurement unit through I2C. * measurement unit through I2C.
*/ */
#include "led.h" #include "led.h"
+30
View File
@@ -1,3 +1,33 @@
/*
* Copyright (C) 2011 Norman Wildmann, Martin Mueller
*
* This file is part of paparazzi.
*
* paparazzi is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* paparazzi is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* 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.
*
*/
/**
* @file modules/meteo/humid_pcap01.h
* @brief ACAM Picocap Single-chip Solution for Capacitance Measurement
*
* This reads the values for temperature and humidity from the ACAM capacitance and resistance
* measurement unit through I2C.
*/
#ifndef PCAP01_H #ifndef PCAP01_H
#define PCAP01_H #define PCAP01_H
+1 -1
View File
@@ -22,7 +22,7 @@
*/ */
/** /**
* @file module/nav/nav_catapult.h * @file modules/nav/nav_catapult.h
* @brief catapult launch timing system * @brief catapult launch timing system
* *
* *
+1 -1
View File
@@ -22,7 +22,7 @@
*/ */
/** /**
* @file module/nav/nav_catapult.h * @file modules/nav/nav_catapult.h
* @brief catapult launch timing system * @brief catapult launch timing system
*/ */
+4 -2
View File
@@ -20,8 +20,10 @@
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
* *
*/ */
/** \file srf08.c
* \brief Basic library for SRF08 telemeter /**
* @file modules/sensors/alt_srf08.c
* @brief Basic library for SRF08 telemeter
* *
*/ */
+4 -2
View File
@@ -20,8 +20,10 @@
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
* *
*/ */
/** \file srf08.h
* \brief Basic library for SRF08 telemeter /**
* @file modules/sensors/alt_srf08.h
* @brief Basic library for SRF08 telemeter
* *
*/ */
+3 -2
View File
@@ -20,8 +20,9 @@
* *
*/ */
/** \file baro_MS5534A.c /**
* \brief Handling of the MS5534a pressure sensor * @file modules/sensors/baro_MS5534A.c
* @brief Handling of the MS5534a pressure sensor
* *
* uses: MOSI, MISO, SCK and 32kHz @ P0.7 with 5V for the -A type * uses: MOSI, MISO, SCK and 32kHz @ P0.7 with 5V for the -A type
*/ */
+3 -2
View File
@@ -20,8 +20,9 @@
* *
*/ */
/** \file baro_MS5534A.h /**
* \brief Handling of the MS5534a pressure sensor * @file modules/sensors/baro_MS5534A.h
* @brief Handling of the MS5534a pressure sensor
* *
*/ */
+5 -4
View File
@@ -20,11 +20,12 @@
* *
*/ */
/** \file trigger_ext.c /**
* \brief Measure external trigger pulse at PPM input * @file modules/sensors/trigger_ext.c
* Measure external trigger pulse at PPM input
* *
* This measures a trigger pulse length (e.g. duration of a wind turbine * This measures a trigger pulse length (e.g. duration of a wind turbine
* rotation) and sends a message with the info. * rotation) and sends a message with the info.
*/ */
+30
View File
@@ -1,3 +1,33 @@
/*
* Copyright (C) 2010 Martin Mueller
*
* This file is part of paparazzi.
*
* paparazzi is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* paparazzi is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* 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.
*
*/
/**
* @file modules/sensors/trigger_ext.h
* Measure external trigger pulse at PPM input
*
* This measures a trigger pulse length (e.g. duration of a wind turbine
* rotation) and sends a message with the info.
*/
#ifndef TRIGGER_EXT_H #ifndef TRIGGER_EXT_H
#define TRIGGER_EXT_H #define TRIGGER_EXT_H