More documentation updates, standardizing format to include addtogroup at the beginning of headers so files are associated with modules

git-svn-id: svn://svn.openpilot.org/OpenPilot/trunk@1121 ebee16cc-31ac-478f-84a7-5cbb03baadba

flight/Doc/Doxygen/doxygen.cfg

@@ -597,13 +597,13 @@ FILE_PATTERNS          =
 # should be searched for input files as well. Possible values are YES and NO.
 # If left blank NO is used.
 
-RECURSIVE              = NO
+RECURSIVE              = YES
 
 # The EXCLUDE tag can be used to specify files and/or directories that should
 # excluded from the INPUT source files. This way you can easily exclude a
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                =
+EXCLUDE                = .svn
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
 # directories that are symbolic links (a Unix filesystem feature) are excluded
@@ -976,7 +976,7 @@ ENUM_VALUES_PER_LINE   = 4
 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
 # Windows users are probably better off using the HTML help feature.
 
-GENERATE_TREEVIEW      = NO
+GENERATE_TREEVIEW      = YES
 
 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
 # and Class Hierarchy pages using a tree view instead of an ordered list.
@@ -1253,7 +1253,7 @@ PERLMOD_MAKEVAR_PREFIX =
 # evaluate all C-preprocessor directives found in the sources and include
 # files.
 
-ENABLE_PREPROCESSING   = YES
+ENABLE_PREPROCESSING   = NO
 
 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
 # names in the source code. If set to NO (the default) only conditional

flight/OpenPilot/Modules/AHRSComms/ahrs_comms.c

@@ -1,13 +1,5 @@
 /**
  ******************************************************************************
- *
- * @file       ahrs_comms.c
- * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
- * @brief      Module to handle all comms to the AHRS on a periodic basis.
- *
- * @see        The GNU Public License (GPL) Version 3
- *
- *
  * @addtogroup OpenPilotModules OpenPilot Modules
  * @{ 
  * @addtogroup AHRSCommsModule AHRSComms Module
@@ -15,6 +7,12 @@
  * Specifically updates the the @ref AttitudeActual "AttitudeActual" and @ref HeadingActual "HeadingActual" settings objects
  * @{ 
  *
+ * @file       ahrs_comms.c
+ * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
+ * @brief      Module to handle all comms to the AHRS on a periodic basis.
+ *
+ * @see        The GNU Public License (GPL) Version 3
+ *
  ******************************************************************************/
 /*
  * This program is free software; you can redistribute it and/or modify

flight/OpenPilot/Modules/AHRSComms/inc/ahrs_comms.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup AHRSCommsModule AHRSComms Module
+ * @{ 
  *
  * @file       ahrs_comms.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.

flight/OpenPilot/Modules/Actuator/actuator.c

@@ -1,5 +1,11 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup ActuatorModule Actuator Module
+ * @brief Compute servo/motor settings based on @ref ActuatorDesired "desired actuator positions" and aircraft type.
+ * This is where all the mixing of channels is computed.
+ * @{ 
  *
  * @file       actuator.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -24,14 +30,6 @@
  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
-/**
-  * @addtogroup OpenPilotModules OpenPilot Modules
-  * @{ 
-  * @addtogroup ActuatorModule Actuator Module
-  * @brief Compute servo/motor settings based on @ref ActuatorDesired "desired actuator positions" and aircraft type
-  * @{ 
-  */
-
 #include "openpilot.h"
 #include "actuator.h"
 #include "actuatorsettings.h"
@@ -287,8 +285,5 @@ static void setFailsafe()
 
 /** 
  * @}
- */
-
-/** 
   * @}
   */

flight/OpenPilot/Modules/Actuator/inc/actuator.h

@@ -1,5 +1,11 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup ActuatorModule Actuator Module
+ * @brief Compute servo/motor settings based on @ref ActuatorDesired "desired actuator positions" and aircraft type.
+ * This is where all the mixing of channels is computed.
+ * @{ 
  *
  * @file       actuator.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -29,3 +35,8 @@
 int32_t ActuatorInitialize();
 
 #endif // ACTUATOR_H
+
+/**
+  * @}
+  * @}
+  */

flight/OpenPilot/Modules/Altitude/altitude.c

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup AltitudeModule Altitude Module
+ * @brief Communicate with BMP085 and update @ref AltitudeActual "AltitudeActual UAV Object"
+ * @{ 
  *
  * @file       altitude.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -7,12 +12,6 @@
  *
  * @see        The GNU Public License (GPL) Version 3
  *
- /**
- * @addtogroup OpenPilotModules OpenPilot Modules
- * @{ 
- * @addtogroup AltitudeModule Altitude Module
- * @brief Communicate with BMP085 and update @ref AltitudeActual "AltitudeActual UAV Object"
- * @{ 
  *****************************************************************************/
 /*
  * This program is free software; you can redistribute it and/or modify
@@ -114,8 +113,5 @@ static void altitudeTask(void* parameters)
 
 /**
   * @}
-  */
-
-/**
  * @}
  */

flight/OpenPilot/Modules/Altitude/inc/altitude.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup AltitudeModule Altitude Module
+ * @brief Communicate with BMP085 and update @ref AltitudeActual "AltitudeActual UAV Object"
+ * @{ 
  *
  * @file       altitude.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -26,27 +31,12 @@
 #ifndef ALTITUDE_H
 #define ALTITUDE_H
 
-/**
- * @addtogroup OpenPilotModules OpenPilot Modules
- * @{ 
- */
-
-/**
- * @addtogroup AltitudeModule Altitude Module
- * @brief Communicate with BMP085 and update AltitudeActual
- * @{ 
- */
-
 int32_t AltitudeInitialize();
 
-
-/**
- * @}
- */
-
-/**
- * @}
- */
-
 #endif // ALTITUDE_H
 
+/**
+ * @}
+ * @}
+ */
+

flight/OpenPilot/Modules/Battery/battery.c

@@ -1,5 +1,11 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup BatteryModule Battery Module
+ * @brief Measures battery voltage and current
+ * Updates the FlightBatteryState object
+ * @{ 
  *
  * @file       attitude.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -43,19 +49,6 @@
 
 #include "flightbatterystate.h"
 
-
-/**
- * @addtogroup OpenPilotModules OpenPilot Modules
- * @{ 
- */
-
-/**
- * @addtogroup BatteryModule Battery Module
- * @brief Measures battery voltage and current
- * Updates the FlightBatteryState object
- * @{ 
- */
-
 //
 // Configuration
 //

flight/OpenPilot/Modules/Battery/inc/battery.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup BatteryModule Battery Module
+ * @{ 
  *
  * @file       attitude.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -32,3 +36,7 @@ int32_t BatteryInitialize(void);
 
 #endif // BATTERY_H
 
+/**
+  * @}
+  * @}
+  */

flight/OpenPilot/Modules/GPS/GPS.c

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup GSPModule GPS Module
+ * @brief Process GPS information
+ * @{ 
  *
  * @file       GPS.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -28,17 +33,6 @@
 #include "GPS.h"
 #include "positionactual.h"
 
-/**
- * @addtogroup OpenPilotModules OpenPilot Modules
- * @{ 
- */
-
-/**
- * @addtogroup GSPModule GPS Module
- * @brief Process GPS information
- * @{ 
- */
-
 // constants/macros/typdefs
 #define NMEA_BUFFERSIZE		128
 
@@ -725,8 +719,5 @@ void nmeaProcessGPGSA(char* packet)
 
 /** 
   * @}
-  */
-
-/**
   * @}
   */

flight/OpenPilot/Modules/GPS/buffer.c

@@ -1,9 +1,15 @@
 /**
  ******************************************************************************
  *
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup GSPModule GPS Module
+ * @brief Process GPS information
+ * @{ 
+ *
  * @file       buffer.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
- * @brief      see below
+ * @brief      
  * 	       As with all modules only the initialize function is exposed all other
  * 	       interactions with the module take place through the event queue and
  *             objects.
@@ -27,7 +33,6 @@
  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
-/*! \file buffer.c \brief Multipurpose byte buffer structure and methods. */
 //*****************************************************************************
 //
 // File Name	: 'buffer.c'
@@ -46,17 +51,6 @@
 
 #include "buffer.h"
 
-/**
- * @addtogroup OpenPilotModules OpenPilot Modules
- * @{ 
- */
-
-/**
- * @addtogroup GSPModule GPS Module
- * @brief Process GPS information
- * @{ 
- */
-
 // global variables
 
 // initialization
@@ -150,8 +144,5 @@ void bufferFlush(cBuffer* buffer)
 
 /** 
   * @}
-  */
-
-/**
   * @}
   */

flight/OpenPilot/Modules/GPS/inc/GPS.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup GSPModule GPS Module
+ * @brief Process GPS information
+ * @{ 
  *
  * @file       GPS.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -32,3 +37,8 @@
 int32_t GPSInitialize(void);
 
 #endif // GPS_H
+
+/**
+  * @}
+  * @}
+  */

flight/OpenPilot/Modules/GPS/inc/buffer.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup GSPModule GPS Module
+ * @brief Process GPS information
+ * @{ 
  *
  * @file       buffer.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -11,7 +16,6 @@
  *
  *****************************************************************************/
 
-/*! \file buffer.h \brief Multipurpose byte buffer structure and methods. */
 //*****************************************************************************
 //
 // File Name	: 'buffer.h'
@@ -23,8 +27,6 @@
 // Target MCU	: any
 // Editor Tabs	: 4
 //
-///	\ingroup general
-/// \defgroup buffer Circular Byte-Buffer Structure and Function Library (buffer.c)
 /// \code #include "buffer.h" \endcode
 /// \par Overview
 ///		This byte-buffer structure provides an easy and efficient way to store
@@ -84,4 +86,7 @@ unsigned char	bufferIsNotFull(cBuffer* buffer);
 void			bufferFlush(cBuffer* buffer);
 
 #endif
-//@}
+
+/**
+  * @}
+  */

flight/OpenPilot/Modules/MK/MKSerial/MKSerial.c

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup MKSerialModule MK Serial Control Module
+ * @brief Connect to MK module
+ * @{ 
  *
  * @file       MKSerial.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -31,18 +36,6 @@
 #include "flightbatterystate.h"
 
 
-/**
- * @addtogroup OpenPilotModules OpenPilot Modules
- * @{ 
- */
-
-/**
- * @addtogroup MKSerialModule MK Serial Control Module
- * @brief Connect to MK module
- * @{ 
- */
-
-
 //
 // Configuration
 //
@@ -626,8 +619,5 @@ int32_t MKSerialInitialize(void)
 
 /** 
   * @}
-  */
-
-/** 
  * @}
  */

flight/OpenPilot/Modules/MK/MKSerial/inc/MkSerial.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup MKSerialModule MK Serial Control Module
+ * @brief Connect to MK module
+ * @{ 
  *
  * @file       GPS.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -32,3 +37,8 @@
 int32_t MKSerialInitialize(void);
 
 #endif // MK_SER_INPUT_H
+
+/** 
+  * @}
+  * @}
+  */

flight/OpenPilot/Modules/ManualControl/inc/manualcontrol.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup ManualControlModule Manual Control Module
+ * @{
  *
  * @file       manualcontrol.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.

flight/OpenPilot/Modules/ManualControl/manualcontrol.c

@@ -1,5 +1,14 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup ManualControlModule Manual Control Module
+ * @brief Provide manual control or allow it alter flight mode.
+ * @{
+ *
+ * Reads in the ManualControlCommand FlightMode setting from receiver then either 
+ * pass the settings straght to ActuatorDesired object (manual mode) or to
+ * AttitudeDesired object (stabilized mode)
  *
  * @file       manualcontrol.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -32,21 +41,6 @@
 #include "actuatordesired.h"
 #include "attitudedesired.h"
 
-/**
- * @addtogroup OpenPilotModules OpenPilot Modules
- * @{ 
- */
-
-/**
- * @addtogroup ManualControlModule Manual Control Module
- * @brief Provide manual control or allow it alter flight mode
- *
- * Reads in the ManualControlCommand FlightMode setting from receiver then either 
- * pass the settings straght to ActuatorDesired object (manual mode) or to
- * AttitudeDesired object (stabilized mode)
- * @{ 
- */
-
 
 // Private constants
 #define STACK_SIZE configMINIMAL_STACK_SIZE
@@ -241,3 +235,8 @@ static float scaleChannel(int16_t value, int16_t max, int16_t min, int16_t neutr
 	}
 	return valueScaled;
 }
+
+/**
+  * @}
+  * @}
+  */

flight/OpenPilot/Modules/Osd/OsdEtStd/OsdEtStd.c

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup OSDModule OSD Module
+ * @brief On screen display support
+ * @{ 
  *
  * @file       MKSerial.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -28,17 +33,6 @@
 #include "flightbatterystate.h"
 #include "positionactual.h"
 
-/**
- * @addtogroup OpenPilotModules OpenPilot Modules
- * @{ 
- */
-
-/**
- * @addtogroup OSDModule OSD Module
- * @brief On screen display support
- * @{ 
- */
-
 
 
 //

flight/OpenPilot/Modules/Stabilization/inc/stabilization.h

@@ -1,5 +1,12 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup StabilizationModule Stabilization Module
+ * @brief Stabilization PID loops in an airframe type independent manner
+ * @note This object updates the @ref ActuatorDesired "Actuator Desired" based on the 
+ * PID loops on the @ref AttitudeDesired "Attitude Desired" and @ref AttitudeActual "Attitude Actual"
+ * @{ 
  *
  * @file       stabilization.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -29,3 +36,8 @@
 int32_t StabilizationInitialize();
 
 #endif // STABILIZATION_H
+
+/**
+  * @}
+  * @}
+  */

flight/OpenPilot/Modules/Stabilization/stabilization.c

@@ -1,5 +1,12 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup StabilizationModule Stabilization Module
+ * @brief Stabilization PID loops in an airframe type independent manner
+ * @note This object updates the @ref ActuatorDesired "Actuator Desired" based on the 
+ * PID loops on the @ref AttitudeDesired "Attitude Desired" and @ref AttitudeActual "Attitude Actual"
+ * @{ 
  *
  * @file       stabilization.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -33,16 +40,6 @@
 #include "manualcontrolcommand.h"
 #include "systemsettings.h"
 
-/**
- * @addtogroup OpenPilotModules OpenPilot Modules
- * @{ 
- * @addtogroup StabilizationModule Stabilization Module
- * @brief Stabilization PID loops in an airframe type independent manner
- * @note This object updates the @ref ActuatorDesired "Actuator Desired" based on the 
- * PID loops on the @ref AttitudeDesired "Attitude Desired" and @ref AttitudeActual "Attitude Actual"
- * @{ 
- */
-
 
 // Private constants
 #define STACK_SIZE configMINIMAL_STACK_SIZE
@@ -191,9 +188,6 @@ static float bound(float val, float min, float max)
 }
 
 /** 
+  * @}
   * @}
   */
-
-/** 
- * @}
- */

flight/OpenPilot/Modules/System/inc/systemmod.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup SystemModule System Module
+ * @{ 
  *
  * @file       systemmod.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.

flight/OpenPilot/Modules/System/systemmod.c

@@ -1,5 +1,19 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @brief The OpenPilot Modules do the majority of the control in OpenPilot.  The 
+ * @ref SystemModule "System Module" starts all the other modules that then take care
+ * of all the telemetry and control algorithms and such.  This is done through the @ref PIOS 
+ * "PIOS Hardware abstraction layer" which then contains hardware specific implementations
+ * (currently only STM32 supported)
+ *
+ * @{ 
+ * @addtogroup SystemModule System Module
+ * @brief Initializes PIOS and other modules runs monitoring
+ * After initializing all the modules (currently selected by Makefile but in
+ * future controlled by configuration on SD card) runs basic monitoring and
+ * alarms.
+ * @{ 
  *
  * @file       systemmod.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -30,20 +44,6 @@
 #include "systemstats.h"
 
 
-/**
- * @addtogroup OpenPilotModules OpenPilot Modules
- * @{ 
- */
-
-/**
- * @addtogroup SystemModule Main System Module
- * @brief Initializes PIOS and other modules runs monitoring
- * After initializing all the modules (currently selected by Makefile but in
- * future controlled by configuration on SD card) runs basic monitoring and
- * alarms.
- * @{ 
- */
-
 // Private constants
 #define SYSTEM_UPDATE_PERIOD_MS 1000
 #define IDLE_COUNTS_PER_SEC_AT_NO_LOAD 995998 // calibrated by running tests/test_cpuload.c
@@ -334,8 +334,5 @@ void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTask
 
 /**
   * @}
-  */
-
-/**
   * @}
   */

flight/OpenPilot/Modules/Telemetry/inc/telemetry.h

@@ -1,5 +1,12 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup TelemetryModule Telemetry Module
+ * @brief Main telemetry module
+ * Starts three tasks (RX, TX, and priority TX) that watch event queues
+ * and handle all the telemetry of the UAVobjects
+ * @{ 
  *
  * @file       telemetry.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -32,3 +39,8 @@
 int32_t TelemetryInitialize(void);
 
 #endif // TELEMETRY_H
+
+/**
+  * @}
+  * @}
+  */

flight/OpenPilot/Modules/Telemetry/telemetry.c

@@ -1,5 +1,12 @@
 /**
  ******************************************************************************
+ * @addtogroup OpenPilotModules OpenPilot Modules
+ * @{ 
+ * @addtogroup TelemetryModule Telemetry Module
+ * @brief Main telemetry module
+ * Starts three tasks (RX, TX, and priority TX) that watch event queues
+ * and handle all the telemetry of the UAVobjects
+ * @{ 
  *
  * @file       telemetry.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -28,20 +35,6 @@
 #include "gcstelemetrystats.h"
 #include "telemetrysettings.h"
 
-
-/**
- * @addtogroup OpenPilotModules OpenPilot Modules
- * @{ 
- */
-
-/**
- * @addtogroup TelemetryModule Telemetry Module
- * @brief Main telemetry module
- * Starts three tasks (RX, TX, and priority TX) that watch event queues
- * and handle all the telemetry of the UAVobjects
- * @{ 
- */
-
 // Set this to 1 to enable telemetry via the USB HID interface
 #define ALLOW_HID_TELEMETRY 0
 
@@ -567,8 +560,5 @@ static void updateSettings()
 
 /**
   * @}
-  */
-
-/**
   * @}
   */

flight/PiOS/Common/pios_bmp085.c

@@ -1,16 +1,16 @@
 /**
   ******************************************************************************
-  *
-  * @file       pios_bmp085.c  
-  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
-  * @brief      BMP085 Pressure Sensor Routines
-  * @see        The GNU Public License (GPL) Version 3
   * @addtogroup PIOS PIOS Core hardware abstraction layer
   * @{
   * @addtogroup PIOS_BMP085 BMP085 Functions
   * @brief Hardware functions to deal with the altitude pressure sensor
   * @{
   *
+  * @file       pios_bmp085.c  
+  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
+  * @brief      BMP085 Pressure Sensor Routines
+  * @see        The GNU Public License (GPL) Version 3
+  *
   ******************************************************************************/
 /* 
  * This program is free software; you can redistribute it and/or modify 

flight/PiOS/Common/pios_com.c

@@ -1,18 +1,17 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_COM COM layer functions
+ * @brief Hardware communication layer
+ * @{
  *
  * @file       pios_com.c  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * 	       Parts by Thorsten Klose (tk@midibox.org)
  * @brief      COM layer functions
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * 
- * @{
- * @addtogroup PIOS_COM COM layer functions
- * @brief Hardware communication layer
- * @{
- */
-* 
  *****************************************************************************/
 /* 
  * This program is free software; you can redistribute it and/or modify 

flight/PiOS/Common/pios_hmc5843.c

@@ -1,17 +1,16 @@
 /**
  ******************************************************************************
- *
- * @file       pios_hmc5843.c
- * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
- * @brief      HMC5843 Magnetic Sensor Functions
- * @see        The GNU Public License (GPL) Version 3
- *
- /**
  * @addtogroup PIOS PIOS Core hardware abstraction layer
  * @{
  * @addtogroup PIOS_HMC5843 HMC5843 Functions
  * @brief Deals with the hardware interface to the magnetometers
  * @{
+ *
+ * @file       pios_hmc5843.c
+ * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
+ * @brief      HMC5843 Magnetic Sensor Functions from AHRS
+ * @see        The GNU Public License (GPL) Version 3
+ *
  ******************************************************************************
  */
 /* 

flight/PiOS/Common/pios_opahrs.c

@@ -1,15 +1,15 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_OPAHRS OPAHRS Functions
+ * @brief HAL code to interface to the OpenPilot AHRS module
+ * @{
  *
  * @file       pios_opahrs.c  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * @brief      Hardware commands to communicate with the AHRS
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup PIOS_OPAHRS OPAHRS Functions
- * @brief STM32 Hardware code to interface to the OpenPilot AHRS module
- * @{
  * 
  *****************************************************************************/
 /* 

flight/PiOS/Common/pios_opahrs_proto.c

@@ -1,3 +1,16 @@
+/**
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_OPAHRS OPAHRS Functions
+ * @{
+ *
+ * @file       pios_opahrs_proto.c
+ * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
+ * @brief      PPM Input functions
+ * @see        The GNU Public License (GPL) Version 3
+ * 
+ */
+
 #include "pios_opahrs_proto.h"
 #include <string.h>		/* memset */
 
@@ -56,3 +69,8 @@ void opahrs_msg_v1_init_link_tx (struct opahrs_msg_v1 * msg, enum opahrs_msg_lin
 
   msg->tail.magic     = OPAHRS_MSG_MAGIC_TAIL;
 }
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/Common/pios_sdcard.c

@@ -1,16 +1,16 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_SDCARD SDCard Functions
+ * @brief Code to deal with reading and writing to flash cards
+ * @{
  *
  * @file       pios_sdcard.c  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * 	       Parts by Thorsten Klose (tk@midibox.org)
  * @brief      Sets up basic system hardware, functions are called from Main.
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @defgroup   PIOS_SDCARD SDCard Functions
- * @brief STM32 Hardware code to deal with writing to flash
- * @{
  *
  *****************************************************************************/
 /* 

flight/PiOS/Common/printf-stdarg.c

@@ -1,5 +1,7 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
  *
  * @file       printf-stdarg.c   
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -232,3 +234,7 @@ int snprintf( char *buf, size_t count, const char *format, ... )
         va_start( args, format );
         return print( &buf, format, args );
 }
+
+/**
+  * @}
+  */

flight/PiOS/STM32F10x/Libraries/FreeRTOS/Source/include/StackMacros.h

@@ -1,3 +1,12 @@
+/**
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup FreeRTOS FreeRTOS Operating system
+ * @{
+ * @file StackMacros.h
+ * @author FreeRTOS
+ */
+
 /*
     FreeRTOS V6.0.0 - Copyright (C) 2009 Real Time Engineers Ltd.
 

flight/PiOS/STM32F10x/Libraries/FreeRTOS/Source/include/portable.h

@@ -1,3 +1,12 @@
+/**
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup FreeRTOS FreeRTOS Operating system
+ * @{
+ * @file portable.h
+ * @author FreeRTOS
+ */
+
 /*
     FreeRTOS V6.0.0 - Copyright (C) 2009 Real Time Engineers Ltd.
 
@@ -58,14 +67,6 @@
 #ifndef PORTABLE_H
 #define PORTABLE_H
 
-/**
- * @file portable.h
- * @author FreeRTOS
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup FreeRTOS FreeRTOS Operating system
- * @{
- */
 
 /* Include the macro file relevant to the port being used. */
 

flight/PiOS/STM32F10x/Libraries/FreeRTOS/Source/include/queue.h

@@ -1,3 +1,12 @@
+/**
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup FreeRTOS FreeRTOS Operating system
+ * @{
+ * @file queue.h
+ * @author FreeRTOS
+ */
+
 /*
     FreeRTOS V6.0.0 - Copyright (C) 2009 Real Time Engineers Ltd.
 
@@ -56,15 +65,6 @@
 #endif
 
 
-/**
- * @file queue.h
- * @author FreeRTOS
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup FreeRTOS FreeRTOS Operating system
- * @{
- */
-
 #ifndef QUEUE_H
 #define QUEUE_H
 

flight/PiOS/STM32F10x/Libraries/FreeRTOS/Source/include/semphr.h

@@ -1,3 +1,12 @@
+/**
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup FreeRTOS FreeRTOS Operating system
+ * @{
+ * @file tasks.c
+ * @author FreeRTOS
+ */
+
 /*
     FreeRTOS V6.0.0 - Copyright (C) 2009 Real Time Engineers Ltd.
 
@@ -58,14 +67,7 @@
 #ifndef SEMAPHORE_H
 #define SEMAPHORE_H
 
-/**
+
- * @file tasks.c
- * @author FreeRTOS
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup FreeRTOS FreeRTOS Operating system
- * @{
- */
 
 #include "queue.h"
 
@@ -718,3 +720,7 @@ typedef xQueueHandle xSemaphoreHandle;
 #endif /* SEMAPHORE_H */
 
 
+/**
+  * @}
+  * @}
+  */

flight/PiOS/STM32F10x/Libraries/FreeRTOS/Source/portable/GCC/ARM_CM3/port.c

@@ -1,3 +1,13 @@
+/**
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup FreeRTOS FreeRTOS Operating system
+ * @{
+ *
+ * @file port.c
+ * @author FreeRTOS
+ */
+
 /*
     FreeRTOS V6.0.0 - Copyright (C) 2009 Real Time Engineers Ltd.
 
@@ -51,15 +61,6 @@
     licensing and training services.
 */
 
-/**
- * @file port.c
- * @author FreeRTOS
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup FreeRTOS FreeRTOS Operating system
- * @{
- */
-
 /*-----------------------------------------------------------
  * Implementation of functions defined in portable.h for the ARM CM3 port.
  *----------------------------------------------------------*/

flight/PiOS/STM32F10x/Libraries/FreeRTOS/Source/portable/GCC/ARM_CM3/portmacro.h

@@ -1,3 +1,13 @@
+/**
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup FreeRTOS FreeRTOS Operating system
+ * @{
+ * @file portmacro.h
+ * @author FreeRTOS
+ */
+
+
 /*
     FreeRTOS V6.0.0 - Copyright (C) 2009 Real Time Engineers Ltd.
 
@@ -55,14 +65,6 @@
 #ifndef PORTMACRO_H
 #define PORTMACRO_H
 
-/**
- * @file portmacro.h
- * @author FreeRTOS
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup FreeRTOS FreeRTOS Operating system
- * @{
- */
 
 #ifdef __cplusplus
 extern "C" {

flight/PiOS/STM32F10x/Libraries/FreeRTOS/Source/queue.c

@@ -1,3 +1,12 @@
+/**
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup FreeRTOS FreeRTOS Operating system
+ * @{
+ * @file queue.c
+ * @author FreeRTOS
+ */
+
 /*
     FreeRTOS V6.0.0 - Copyright (C) 2009 Real Time Engineers Ltd.
 
@@ -54,15 +63,6 @@
 #include <stdlib.h>
 #include <string.h>
 
-/**
- * @file queue.c
- * @author FreeRTOS
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup FreeRTOS FreeRTOS Operating system
- * @{
- */
-
 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining
 all the API functions to use the MPU wrappers.  That should only be done when
 task.h is included from an application file. */

flight/PiOS/STM32F10x/pios_adc.c

@@ -1,16 +1,16 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_ADC ADC Functions
+ * @brief STM32 ADC PIOS interface
+ * @{
  *
  * @file       pios_adc.c  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * 	        Parts by Thorsten Klose (tk@midibox.org) (tk@midibox.org)
  * @brief      Analog to Digital converstion routines
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup   PIOS_ADC ADC Functions
- * @brief Analog to Digital PIOS interface
- * @{
  *****************************************************************************/
 /* 
  * This program is free software; you can redistribute it and/or modify 
@@ -207,9 +207,9 @@ void DMA1_Channel1_IRQHandler(void)
 	ADC_SoftwareStartConvCmd(ADC1, ENABLE);
 }
 
-/** 
-  * @}
-  * @}
-  */
-
 #endif
+
+/** 
+ * @}
+ * @}
+ */

flight/PiOS/STM32F10x/pios_debug.c

@@ -1,16 +1,16 @@
 /**
  ******************************************************************************
- *
- * @file       pios_debug.c
- * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
- * @brief      Debugging Functions
- * @see        The GNU Public License (GPL) Version 3
  * @addtogroup PIOS PIOS Core hardware abstraction layer
  * @{
  * @defgroup   PIOS_DEBUG Debugging Functions
  * @brief Debugging functionality
  * @{
  *
+ * @file       pios_debug.c
+ * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
+ * @brief      Debugging Functions
+ * @see        The GNU Public License (GPL) Version 3
+ * 
  *****************************************************************************/
 /* 
  * This program is free software; you can redistribute it and/or modify 

flight/PiOS/STM32F10x/pios_delay.c

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_DELAY Delay Functions
+ * @brief PiOS Delay functionality
+ * @{
  *
  * @file       pios_delay.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -7,11 +12,6 @@
  * @brief      Delay Functions 
  *                 - Provides a micro-second granular delay using a TIM 
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @defgroup   PIOS_DELAY Delay Functions
- * @brief PiOS Delay functionality
- * @{
  *
  *****************************************************************************/
 /* 
@@ -108,3 +108,8 @@ int32_t PIOS_DELAY_WaitmS(uint16_t mS)
 }
 
 #endif
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/STM32F10x/pios_exti.c

@@ -1,14 +1,17 @@
 /**
  ******************************************************************************
  *
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_EXTI External Interrupt Handlers
+ * @brief External interrupt handler functions
+ * @note Currently deals with BMP085 readings
+ * @{
+ *
  * @file       pios_exti.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * @brief      External Interrupt Handlers
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup PIOS_EXTI External Interrupt Handlers
- * @{
  *
  *****************************************************************************/
 /* 

flight/PiOS/STM32F10x/pios_gpio.c

@@ -1,16 +1,16 @@
 /**
  ******************************************************************************
- *
- * @file       pios_gpio.c
- * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
- * @brief      GPIO functions, init, toggle, on & off.
- * @see        The GNU Public License (GPL) Version 3
  * @addtogroup PIOS PIOS Core hardware abstraction layer
  * @{
  * @defgroup   PIOS_GPIO GPIO Functions
  * @brief GPIO hardware code for STM32
  * @{
  *
+ * @file       pios_gpio.c
+ * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
+ * @brief      GPIO functions, init, toggle, on & off.
+ * @see        The GNU Public License (GPL) Version 3
+ *
  *****************************************************************************/
 /* 
  * This program is free software; you can redistribute it and/or modify 

flight/PiOS/STM32F10x/pios_i2c.c

@@ -1,15 +1,16 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_I2C I2C Functions
+ * @brief STM32 Hardware dependent I2C functionality
+ * @{
  *
  * @file       pios_i2c.c  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * 	        Parts by Thorsten Klose (tk@midibox.org) (tk@midibox.org)
  * @brief      I2C Enable/Disable routines
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @defgroup   PIOS_I2C I2C Functions
- * @{
  * 
  *****************************************************************************/
 /* 

flight/PiOS/STM32F10x/pios_irq.c

@@ -1,16 +1,16 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_IRQ IRQ Setup Functions
+ * @brief STM32 Hardware code to enable and disable interrupts
+ * @{
  *
  * @file       pios_irq.c  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * 	        Parts by Thorsten Klose (tk@midibox.org) (tk@midibox.org)
  * @brief      IRQ Enable/Disable routines
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @defgroup PIOS_IRQ IRQ Setup Functions
- * @brief STM32 Hardware code to enable and disable interrupts
- * @{
  * 
  *****************************************************************************/
 /* 

flight/PiOS/STM32F10x/pios_led.c

@@ -1,16 +1,16 @@
 /**
  ******************************************************************************
- *
- * @file       pios_led.c   
- * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
- * @brief      LED functions, init, toggle, on & off.
- * @see        The GNU Public License (GPL) Version 3
  * @addtogroup PIOS PIOS Core hardware abstraction layer
  * @{
  * @addtogroup PIOS_LED LED Functions
  * @brief STM32 Hardware LED handling code
  * @{
  *
+ * @file       pios_led.c   
+ * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
+ * @brief      LED functions, init, toggle, on & off.
+ * @see        The GNU Public License (GPL) Version 3
+ *
  *****************************************************************************/
 /* 
  * This program is free software; you can redistribute it and/or modify 

flight/PiOS/STM32F10x/pios_ppm.c

@@ -1,15 +1,15 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_PPM PPM Input Functions
+ * @brief Code to measure PPM input and seperate into channels
+ * @{
  *
  * @file       pios_ppm.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
- * @brief      PPM Input functions
+ * @brief      PPM Input functions (STM32 dependent)
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @defgroup   PIOS_PPM PPM Input Functions
- * @brief STM32 Hardware code to deal with PPM input
- * @{
  *
  *****************************************************************************/
 /*

flight/PiOS/STM32F10x/pios_pwm.c

@@ -1,15 +1,15 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_PWM PWM Input Functions
+ * @brief		Code to measure with PWM input
+ * @{
  *
  * @file       pios_pwm.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
- * @brief      PWM Input functions
+ * @brief      PWM Input functions (STM32 dependent)
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @defgroup   PIOS_PWM PWM Input Functions
- * @brief STM32 Hardware code to deal with PWM input
- * @{
  *
  *****************************************************************************/
 /*

flight/PiOS/STM32F10x/pios_servo.c

@@ -1,15 +1,15 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_SERVO RC Servo Functions
+ * @brief Code to do set RC servo output
+ * @{
  *
  * @file       pios_servo.c  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
- * @brief      RC Servo routines
+ * @brief      RC Servo routines (STM32 dependent)
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @defgroup   PIOS_SERVO RC Servo Functions
- * @brief STM32 Hardware code to do RC servo output
- * @{
  * 
  *****************************************************************************/
 /* 

flight/PiOS/STM32F10x/pios_spektrum.c

@@ -1,16 +1,16 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_SPEKTRUM Spektrum receiver functions
+ * @brief Code to read Spektrum input
+ * @{
  *
  * @file       pios_spektrum.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * 	        Parts by Thorsten Klose (tk@midibox.org) (tk@midibox.org)
- * @brief      USART commands. Inits USARTs, controls USARTs & Interrupt handlers.
+ * @brief      USART commands. Inits USARTs, controls USARTs & Interrupt handlers. (STM32 dependent)
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @defgroup   PIOS_SPEKTRUM USART Functions
- * @brief STM32 Hardware code to read Spektrum input
- * @{
  *
  *****************************************************************************/
 /* 

flight/PiOS/STM32F10x/pios_spi.c

@@ -1,21 +1,21 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_SPI SPI Functions
+ * @brief PIOS interface to read and write from SPI ports
+ * @{
  *
  * @file       pios_spi.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * 	        Parts by Thorsten Klose (tk@midibox.org) (tk@midibox.org)
  * @brief      Hardware Abstraction Layer for SPI ports of STM32
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup   PIOS_SPI SPI Functions
- * @brief STM32 Hardware SPI code
  * @notes
  *
  * Note that additional chip select lines can be easily added by using
  * the remaining free GPIOs of the core module. Shared SPI ports should be
  * arbitrated with (FreeRTOS based) Mutexes to avoid collisions!
- * @{
  *
  *****************************************************************************/
 /*

flight/PiOS/STM32F10x/pios_sys.c

@@ -1,16 +1,16 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_SYS System Functions
+ * @brief PIOS System Initialization code
+ * @{
  *
  * @file       pios_sys.c  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * 	        Parts by Thorsten Klose (tk@midibox.org) (tk@midibox.org)
- * @brief      Sets up basic system hardware, functions are called from Main.
+ * @brief      Sets up basic STM32 system hardware, functions are called from Main.
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @defgroup   PIOS_SYS System Functions
- * @brief Initialization code for STM32
- * @{
  *
  *****************************************************************************/
 /* 

flight/PiOS/STM32F10x/pios_usart.c

@@ -1,18 +1,17 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_USART USART Functions
+ * @brief PIOS interface for USART port
+ * @{
  *
  * @file       pios_usart.c   
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * 	        Parts by Thorsten Klose (tk@midibox.org) (tk@midibox.org)
- * @brief      USART commands. Inits USARTs, controls USARTs & Interupt handlers.
+ * @brief      USART commands. Inits USARTs, controls USARTs & Interupt handlers. (STM32 dependent)
  * @see        The GNU Public License (GPL) Version 3
  *
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup   PIOS_USART USART Functions
- * @brief STM32 Hardware USART code
- * @{
- *
  *****************************************************************************/
 /* 
  * This program is free software; you can redistribute it and/or modify 

flight/PiOS/STM32F10x/pios_usb.c

@@ -1,16 +1,16 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_USB USB Functions
+ * @brief PIOS USB interface code
+ * @{
  *
  * @file       pios_usb.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * 		Parts by Thorsten Klose (tk@midibox.org)
- * @brief      USB functions
+ * @brief      USB functions (STM32 dependent)
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup   PIOS_USB USB Functions
- * @brief STM32 Hardware USB functions
- * @{
  *
  *****************************************************************************/
 /*

flight/PiOS/STM32F10x/pios_usb_com.c

@@ -1,16 +1,16 @@
 /**
  ******************************************************************************
- *
- * @file       pios_usb_com.c
- * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2009.
- * @brief      Sets up basic system hardware, functions are called from Main.
- * @see        The GNU Public License (GPL) Version 3
  * @addtogroup PIOS PIOS Core hardware abstraction layer
  * @{
  * @addtogroup PIOS_SYS System Functions
- * @brief STM32 Hardware USB communication code
+ * @brief PIOS USB communication code
  * @{
  *
+ * @file       pios_usb_com.c
+ * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2009.
+ * @brief      Sets up STM32 USB communications
+ * @see        The GNU Public License (GPL) Version 3
+ *
  *****************************************************************************/
 /*
  * This program is free software; you can redistribute it and/or modify

flight/PiOS/STM32F10x/pios_usb_hid.c

@@ -1,18 +1,18 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_USB_HID USB HID Functions
+ * @brief PIOS USB HID implementation
+ * @notes      This implements a very simple HID device with a simple data in
+ * and data out endpoints.
+ * @{
  *
  * @file       pios_usb_hid.c
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * 		Parts by Thorsten Klose (tk@midibox.org)
- * @brief      USB HID functions
+ * @brief      USB HID functions (STM32 dependent code)
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup   PIOS_USB_HID USB HID Functions
- * @brief STM32 Hardware HID functions
- * @notes      This implements a very simple HID device with a simple data in
- * and data out endpoints.
- * @{
  *
  *****************************************************************************/
 /*
@@ -319,3 +319,8 @@ void PIOS_USB_HID_EP1_OUT_Callback(void)
 }
 
 #endif
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_adc.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_ADC ADC Functions
+ * @brief STM32 ADC PIOS interface
+ * @{
  *
  * @file       pios_adc.h  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -32,3 +37,8 @@ extern void PIOS_ADC_Init(void);
 extern int32_t PIOS_ADC_PinGet(uint32_t pin);
 
 #endif /* PIOS_ADC_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_bmp085.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_BMP085 BMP085 Functions
+ * @brief Hardware functions to deal with the altitude pressure sensor
+ * @{
  *
  * @file       pios_bmp085.h  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -74,3 +79,8 @@ extern int32_t PIOS_BMP085_Read(uint8_t address, uint8_t *buffer, uint8_t len);
 extern int32_t PIOS_BMP085_Write(uint8_t address, uint8_t buffer);
 
 #endif /* PIOS_BMP085_H */
+
+/** 
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_com.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_COM COM layer functions
+ * @brief Hardware communication layer
+ * @{
  *
  * @file       pios_com.h  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -53,3 +58,8 @@ struct pios_com_driver {
 };
 
 #endif /* PIOS_COM_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_com_priv.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_COM COM layer functions
+ * @brief Hardware communication layer
+ * @{
  *
  * @file       pios_com_priv.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -39,3 +44,7 @@ extern const uint8_t             pios_com_num_devices;
 
 #endif /* PIOS_COM_PRIV_H */
 
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_debug.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @defgroup   PIOS_DEBUG Debugging Functions
+ * @brief Debugging functionality
+ * @{
  *
  * @file       pios_i2c.h  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -40,3 +45,8 @@ void PIOS_DEBUG_Panic(const char* msg);
 #endif
 
 #endif /* PIOS_DEBUG_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_delay.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_DELAY Delay Functions
+ * @brief PiOS Delay functionality
+ * @{
  *
  * @file       pios_settings.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -35,3 +40,8 @@ extern int32_t PIOS_DELAY_WaitmS(uint16_t mS);
 
 
 #endif /* PIOS_DELAY_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_exti.h

@@ -1,6 +1,11 @@
 /**
  ******************************************************************************
  *
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_EXTI External Interrupt Handlers
+ * @{
+ *
  * @file       pios_exti.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * @brief      External Interrupts Handlers header.
@@ -30,3 +35,8 @@
 
 
 #endif /* PIOS_EXTI_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_gpio.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @defgroup   PIOS_GPIO GPIO Functions
+ * @brief GPIO hardware code for STM32
+ * @{
  *
  * @file       pios_gpio.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -35,3 +40,8 @@ extern void PIOS_GPIO_Off(uint8_t Pin);
 extern void PIOS_GPIO_Toggle(uint8_t Pin);
 
 #endif /* PIOS_GPIO_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_hmc5843.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_HMC5843 HMC5843 Functions
+ * @brief Deals with the hardware interface to the magnetometers
+ * @{
  *
  * @file       pios_hmc5843.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -102,3 +107,8 @@ extern int32_t PIOS_HMC5843_Read(uint8_t address, uint8_t *buffer, uint8_t len);
 extern int32_t PIOS_HMC5843_Write(uint8_t address, uint8_t buffer);
 
 #endif /* PIOS_HMC5843_H */
+
+/** 
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_i2c.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_I2C I2C Functions
+ * @{
  *
  * @file       pios_i2c.h  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -61,3 +65,8 @@ extern void PIOS_I2C_UnlockDevice(void);
 #endif // PIOS_INCLUDE_FREERTOS
 
 #endif /* PIOS_I2C_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_irq.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_IRQ IRQ Setup Functions
+ * @{
  *
  * @file       pios_irq.h  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.

flight/PiOS/inc/pios_led.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_LED LED Functions
+ * @{
  *
  * @file       pios_led.h   
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.

flight/PiOS/inc/pios_opahrs.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_OPAHRS OPAHRS Functions
+ * @{
  *
  * @file       pios_opahrs.h  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -42,3 +46,8 @@ extern enum opahrs_result PIOS_OPAHRS_GetHeading(struct opahrs_msg_v1 *rsp);
 extern enum opahrs_result PIOS_OPAHRS_resync(void);
 
 #endif /* PIOS_OPAHRS_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_opahrs_proto.h

@@ -1,3 +1,16 @@
+/**
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_OPAHRS OPAHRS Functions
+ * @{
+ *
+ * @file       pios_opahrs_proto.h
+ * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
+ * @brief      PPM Input functions
+ * @see        The GNU Public License (GPL) Version 3
+ * 
+ */
+
 #ifndef PIOS_OPAHRS_PROTO_H
 #define PIOS_OPAHRS_PROTO_H
 
@@ -271,3 +284,8 @@ extern void opahrs_msg_v1_init_user_tx (struct opahrs_msg_v1 * msg, enum opahrs_
 extern void opahrs_msg_v1_init_link_tx (struct opahrs_msg_v1 * msg, enum opahrs_msg_link_tag tag);
 
 #endif /* PIOS_OPAHRS_PROTO_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_ppm.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_PPM PPM Input Functions
+ * @{
  *
  * @file       pios_ppm.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.

flight/PiOS/inc/pios_pwm.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_PWM PWM Input Functions
+ * @{
  *
  * @file       pios_pwm.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.

flight/PiOS/inc/pios_sdcard.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_SDCARD SDCard Functions
+ * @{
  * 
  * @file       pios_sdcard.h  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.

flight/PiOS/inc/pios_servo.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_SERVO RC Servo Functions
+ * @{
  *
  * @file       pios_servo.h  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -32,3 +36,8 @@ extern void PIOS_Servo_SetHz(uint16_t onetofour, uint16_t fivetoeight);
 extern void PIOS_Servo_Set(uint8_t Servo, uint16_t Position);
 
 #endif /* PIOS_SERVO_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_spektrum.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_SPEKTRUM Spektrum receiver functions
+ * @{
  *
  * @file       pios_spektrum.h  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -37,3 +41,8 @@ extern int32_t PIOS_SPEKTRUM_Decode(uint8_t b);
 extern int16_t PIOS_SPEKTRUM_Get(int8_t Channel);
 
 #endif /* PIOS_SPEKTRUM_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_spi.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_SPI SPI Functions
+ * @{
  *
  * @file       pios_spi.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -48,3 +52,8 @@ extern int32_t PIOS_SPI_TransferBlock(uint8_t spi, const uint8_t *send_buffer, u
 extern void    PIOS_SPI_IRQ_Handler(uint8_t spi);
 
 #endif /* PIOS_SPI_H */
+
+/**
+ * @}
+ * @}
+ */

flight/PiOS/inc/pios_spi_priv.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_SPI SPI Functions
+ * @brief PIOS interface to read and write from SPI ports
+ * @{
  *
  * @file       pios_spi_priv.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -52,3 +57,8 @@ extern struct pios_spi_dev pios_spi_devs[];
 extern uint8_t             pios_spi_num_devices;
 
 #endif /* PIOS_SPI_PRIV_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_stm32.h

@@ -1,14 +1,15 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_STM32 STM32 HAL
+ * @brief STM32 specific global data structures 
+ * @{
  *
  * @file       pios_stm32.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  * @brief      Types that are specific to the STM32 peripherals
  * @see        The GNU Public License (GPL) Version 3
- * @addtogroup PIOS PIOS Core hardware abstraction layer
- * @{
- * @addtogroup PIOS_STM32 STM32 HAL
- * @{
  *
  *****************************************************************************/
 /* 

flight/PiOS/inc/pios_sys.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_SYS System Functions
+ * @brief PIOS System Initialization code
+ * @{
  *
  * @file       pios_sys.h  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -33,3 +38,8 @@ extern int32_t PIOS_SYS_Reset(void);
 extern int32_t PIOS_SYS_SerialNumberGet(char *str);
 
 #endif /* PIOS_SYS_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_usart.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_USART USART Functions
+ * @brief PIOS interface for USART port
+ * @{
  *
  * @file       pios_usart.h  
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -49,3 +54,8 @@ extern int32_t PIOS_USART_TxBufferPut(uint8_t usart, uint8_t b);
 
 extern void PIOS_USART_IRQ_Handler(uint8_t usart);
 #endif /* PIOS_USART_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_usart_priv.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_USART USART Functions
+ * @brief PIOS interface for USART port
+ * @{
  *
  * @file       pios_usart_priv.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -56,3 +61,8 @@ extern struct pios_usart_dev pios_usart_devs[];
 extern uint8_t             pios_usart_num_devices;
 
 #endif /* PIOS_USART_PRIV_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_usb.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_USB USB Functions
+ * @brief PIOS USB interface code
+ * @{
  *
  * @file       pios_usb.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -74,3 +79,8 @@ extern int32_t PIOS_USB_IsInitialized(void);
 extern int32_t PIOS_USB_CableConnected(void);
 
 #endif /* PIOS_USB_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_usb_com.h

@@ -1,5 +1,10 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup PIOS_SYS System Functions
+ * @brief PIOS USB communication code
+ * @{
  *
  * @file       pios_usb_com.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2009.
@@ -71,3 +76,8 @@ extern s32 PIOS_USB_COM_TxBufferPutMore_NonBlocking(u8 usb_com, u8 *buffer, u16
 extern s32 PIOS_USB_COM_TxBufferPutMore(u8 usb_com, u8 *buffer, u16 len);
 
 #endif /* PIOS_USB_COM_H */
+
+/**
+  * @}
+  * @}
+  */

flight/PiOS/inc/pios_usb_hid.h

@@ -1,5 +1,9 @@
 /**
  ******************************************************************************
+ * @addtogroup PIOS PIOS Core hardware abstraction layer
+ * @{
+ * @addtogroup   PIOS_USB_HID USB HID Functions
+ * @{
  *
  * @file       pios_usb_hid.h
  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
@@ -49,3 +53,8 @@ extern int32_t PIOS_USB_HID_CB_NoData_Setup(uint8_t RequestNo);
 extern void PIOS_USB_HID_EP1_OUT_Callback(void);
 
 #endif /* PIOS_USB_HID_H */
+
+/**
+  * @}
+  * @}
+  */