Correct several doxygen tags (\file)

avontd2868 · Jul 28, 2014 · 8c3fa17 · 8c3fa17
1 parent f111058
commit 8c3fa17
Show file tree

Hide file tree

Showing 33 changed files with 73 additions and 75 deletions.
diff --git a/core/net/ip/uip.h b/core/net/ip/uip.h
@@ -2032,7 +2032,7 @@ CCIF extern uip_lladdr_t uip_lladdr;
    (((a)->u8[12]) == 0xFF))
 
 /**
- * \briefput in b the solicited node address corresponding to address a
+ * \brief put in b the solicited node address corresponding to address a
  * both a and b are of type uip_ipaddr_t*
  * */
 #define uip_create_solicited_node(a, b)    \

diff --git a/core/sys/lc.h b/core/sys/lc.h
@@ -51,7 +51,7 @@
  */
 
 /**
- * \file lc.h
+ * \file core/sys/lc.h
  * Local continuations
  * \author
  * Adam Dunkels <[email protected]>

diff --git a/cpu/pic32/clock.c b/cpu/pic32/clock.c
@@ -41,7 +41,7 @@
  */
 
 /**
- * \file   clock.c
+ * \file   cpu/pic32/clock.c
  * \brief  Clock routines.
  * \author Giovanni Pellerano <[email protected]>
  * \author Daniele Alessandrelli <[email protected]>

diff --git a/cpu/pic32/debug-uart.c b/cpu/pic32/debug-uart.c
@@ -41,7 +41,7 @@
  */
 
 /**
- * \file   debug-uart.h
+ * \file   cpu/pic32/debug-uart.h
  * \brief  Debug output redirection to uart.
  * \author Giovanni Pellerano <[email protected]>
  * \date   2012-03-21

diff --git a/cpu/pic32/debug-uart.h b/cpu/pic32/debug-uart.h
@@ -41,7 +41,7 @@
  */
 
 /**
- * \file   debug-uart.h
+ * \file   cpu/pic32/debug-uart.h
  * \brief  Debug output redirection to uart.
  * \author Giovanni Pellerano <[email protected]>
  * \date   2012-03-21

diff --git a/cpu/pic32/dev/uart1.h b/cpu/pic32/dev/uart1.h
@@ -34,8 +34,8 @@
  *
  */
 
-/** 
- * @file uart1.h
+/**
+ * @file cpu/pic32/dev/uart1.h
  * @brief UART1 routines
  * @author Giovanni Pellerano <[email protected]>
  *

diff --git a/cpu/pic32/mtarch.h b/cpu/pic32/mtarch.h
@@ -40,8 +40,8 @@
  * @{
  */
 
-/** 
- * \file   mtarch.h
+/**
+ * \file   cpu/pic32/mtarch.h
  * \brief  Implementation of multithreading in PIC32. To be done.
  * \author Giovanni Pellerano <[email protected]>
  * \date   2012-03-23

diff --git a/cpu/pic32/pic32.c b/cpu/pic32/pic32.c
@@ -40,8 +40,8 @@
  * @{
  */
 
-/** 
- * \file   mtarch.h
+/**
+ * \file   cpu/pic32/mtarch.h
  * \brief  PIC32MX initialization routines
  * \author Giovanni Pellerano <[email protected]>
  * \author Daniele Alessandrelli <[email protected]>

diff --git a/cpu/pic32/rtimer-arch.c b/cpu/pic32/rtimer-arch.c
@@ -41,7 +41,7 @@
  */
 
 /**
- * \file   rtimer-arch.c
+ * \file   cpu/pic32/rtimer-arch.c
  * \brief  PIC32MX RTIMER routines
  * \author Giovanni Pellerano <[email protected]>
  * \date   2012-04-11

diff --git a/cpu/pic32/rtimer-arch.h b/cpu/pic32/rtimer-arch.h
@@ -40,8 +40,8 @@
  * @{
  */
 
-/** 
- * \file   rtimer-arch.h
+/**
+ * \file   cpu/pic32/rtimer-arch.h
  * \brief  PIC32MX RTIMER routines
  * \author Giovanni Pellerano <[email protected]>
  * \date   2012-04-11

diff --git a/cpu/pic32/watchdog.c b/cpu/pic32/watchdog.c
@@ -40,8 +40,8 @@
  * @{
  */
 
-/** 
- * \file   watchdog.c
+/**
+ * \file   cpu/pic32/watchdog.c
  * \brief  PIC32MX Watchdog routines
  * \author Giovanni Pellerano <[email protected]>
  * \date   2012-03-23

diff --git a/cpu/stm32w108/hal/error.h b/cpu/stm32w108/hal/error.h
@@ -1,5 +1,5 @@
 /**
- * @file error.h
+ * @file cpu/stm32w108/hal/error.h
  * @brief Return codes for API functions and module definitions.
  *
  * See @ref status_codes for documentation.

diff --git a/cpu/stm32w108/hal/micro/cortexm3/adc.c b/cpu/stm32w108/hal/micro/cortexm3/adc.c
@@ -1,4 +1,4 @@
-/** @file adc.c
+/** @file cpu/stm32w108/hal/micro/cortexm3/adc.c
  * @brief  ADC HAL functions
  *
  * <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved.        -->

diff --git a/cpu/stm32w108/hal/micro/cortexm3/mems.c b/cpu/stm32w108/hal/micro/cortexm3/mems.c
@@ -1,4 +1,4 @@
-/** @file mems.c
+/** @file cpu/stm32w108/hal/micro/cortexm3/mems.c
  * @brief MB851 MEMS drivers
  *
  *

diff --git a/cpu/stm32w108/hal/micro/cortexm3/mfg-token.h b/cpu/stm32w108/hal/micro/cortexm3/mfg-token.h
@@ -1,5 +1,5 @@
-/** @file hal/micro/cortexm3/mfg-token.h
- * @brief Cortex-M3 Manufacturing token system 
+/** \file cpu/stm32w108/hal/micro/cortexm3/mfg-token.h
+ * \brief Cortex-M3 Manufacturing token system
  *
  * <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved.        -->
  */
@@ -16,77 +16,77 @@
 #define DEFINETOKENS
 
 /**
- * @description Macro for translating token defs into address variables
+ * \brief Macro for translating token defs into address variables
  * that point to the correct location in the Info Blocks.  (This is the
  * extern, the actual definition is found in hal/micro/cortexm3/token.c)
  *
- * @param name: The name of the token.
+ * \param name: The name of the token.
  *
- * @param TOKEN_##name##_ADDRESS: The address in EEPROM at which the token
+ * \param TOKEN_##name##_ADDRESS: The address in EEPROM at which the token
  * will be stored.  This parameter is generated with a macro above.
  */
 #define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \
   extern const uint16_t TOKEN_##name;
-  #include "hal/micro/cortexm3/token-manufacturing.h"
+  #include "cpu/stm32w108/hal/micro/cortexm3/token-manufacturing.h"
 #undef TOKEN_MFG
 
 /**
- * @description Macro for translating token definitions into size variables.
+ * \brief Macro for translating token definitions into size variables.
  * This provides a convenience for abstracting the 'sizeof(type)' anywhere.
  *
- * @param name: The name of the token.
+ * \param name: The name of the token.
  *
- * @param type: The token type.  The types are found in token-stack.h.
+ * \param type: The token type.  The types are found in token-stack.h.
  */
 #define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \
   TOKEN_##name##_SIZE = sizeof(type),
   enum {
-    #include "hal/micro/cortexm3/token-manufacturing.h"
+    #include "cpu/stm32w108/hal/micro/cortexm3/token-manufacturing.h"
   };
 #undef TOKEN_MFG
 #undef TOKEN_DEF
-  
+
 /**
- * @description Macro for typedef'ing the CamelCase token type found in
+ * \brief Macro for typedef'ing the CamelCase token type found in
  * token-stack.h to a capitalized TOKEN style name that ends in _TYPE.
  * This macro allows other macros below to use 'token##_TYPE' to declare
  * a local copy of that token.
  *
- * @param name: The name of the token.
+ * \param name: The name of the token.
  *
- * @param type: The token type.  The types are found in token-stack.h.
+ * \param type: The token type.  The types are found in token-stack.h.
  */
 #define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \
   typedef type TOKEN_##name##_TYPE;
-  #include "hal/micro/cortexm3/token-manufacturing.h"
+  #include "cpu/stm32w108/hal/micro/cortexm3/token-manufacturing.h"
 #undef TOKEN_MFG
 
-#undef TOKEN_NEXT_ADDRESS  
-  
+#undef TOKEN_NEXT_ADDRESS
+
 #define DEFINEADDRESSES
 /**
- * @description Macro for creating a 'region' element in the enum below.  This
+ * \brief Macro for creating a 'region' element in the enum below.  This
  * creates an element in the enum that provides a starting point (address) for
  * subsequent tokens to align against.  ( See hal/micro/cortexm3/token.c for
  * the instances of TOKEN_NEXT_ADDRESS() );
  *
- * @param region: The name to give to the element in the address enum..
+ * \param region: The name to give to the element in the address enum..
  *
- * @param address: The address in EEPROM where the region begins.
+ * \param address: The address in EEPROM where the region begins.
  */
 #define TOKEN_NEXT_ADDRESS(region, address)      \
   TOKEN_##region##_NEXT_ADDRESS = ((address) - 1),
 
 /**
- * @description Macro for creating ADDRESS and END elements for each token in
+ * \brief Macro for creating ADDRESS and END elements for each token in
  * the enum below.  The ADDRESS element is linked to from the the normal
  * TOKEN_##name macro and provides the value passed into the internal token
  * system calls.  The END element is a placeholder providing the starting
  * point for the ADDRESS of the next dynamically positioned token.
  *
- * @param name: The name of the token.
+ * \param name: The name of the token.
  *
- * @param arraysize: The number of elements in an indexed token (arraysize=1
+ * \param arraysize: The number of elements in an indexed token (arraysize=1
  * for scalar tokens).
  */
 #define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \
@@ -95,7 +95,7 @@
                        (TOKEN_##name##_SIZE * arraysize) - 1,
 
 /**
- * @description The enum that operates on the two macros above.  Also provides
+ * \brief The enum that operates on the two macros above.  Also provides
  * an indentifier so the address of the top of the token system can be known.
  */
 enum {
@@ -109,26 +109,26 @@ enum {
 
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 /**
- * @description Copies the token value from non-volatile storage into a RAM
+ * \brief Copies the token value from non-volatile storage into a RAM
  * location.  This is the internal function that the exposed API
  * (halCommonGetMfgToken) expands out to.  The
  * API simplifies the access into this function by hiding the size parameter.
  *
- * @param data: A pointer to where the data being read should be placed.
+ * \param data: A pointer to where the data being read should be placed.
  *
- * @param token: The name of the token to get data from.  On this platform
+ * \param token: The name of the token to get data from.  On this platform
  * that name is defined as an address.
  *
- * @param index: The index to access.  If the token being accessed is not an
+ * \param index: The index to access.  If the token being accessed is not an
  * indexed token, this parameter is set by the API to be 0x7F.
  *
- * @param len: The length of the token being worked on.  This value is
+ * \param len: The length of the token being worked on.  This value is
  * automatically set by the API to be the size of the token.
  */
 void halInternalGetMfgTokenData(void *data, uint16_t token, uint8_t index, uint8_t len);
 
 /**
- * @description Sets the value of a token in non-volatile storage.  This is
+ * \brief Sets the value of a token in non-volatile storage.  This is
  * the internal function that the exposed API (halCommonSetMfgToken)
  * expands out to.  The API simplifies the access into this function
  * by hiding the size parameter.
@@ -139,12 +139,12 @@ void halInternalGetMfgTokenData(void *data, uint16_t token, uint8_t index, uint8
  * <b>REMEMBER:</b> The flash hardware requires writing to 16bit aligned
  * addresses with a length that is multiples of 16bits.
  *
- * @param token: The name of the token to get data from.  On this platform
+ * \param token: The name of the token to get data from.  On this platform
  * that name is defined as an address.
  *
- * @param data: A pointer to the data being written.
+ * \param data: A pointer to the data being written.
  *
- * @param len: The length of the token being worked on.  This value is
+ * \param len: The length of the token being worked on.  This value is
  * automatically set by the API to be the size of the token.
  */
 void halInternalSetMfgTokenData(uint16_t token, void *data, uint8_t len);

diff --git a/cpu/stm32w108/hal/micro/cortexm3/micro-common.h b/cpu/stm32w108/hal/micro/cortexm3/micro-common.h
@@ -203,8 +203,6 @@ void halSleepWithOptions(SleepModes sleepMode, uint32_t gpioWakeBitMask);
  * to 48.5 days.  Any sleep duration greater than this limit will wake up
  * briefly (e.g. 16 microseconds) to reenable another sleep cycle.
  *
- * @nostackusage
- *
  * @param duration The amount of time, expressed in quarter seconds, that the
  * micro should be placed into ::SLEEPMODE_WAKETIMER.  When the function returns,
  * this parameter provides the amount of time remaining out of the original

diff --git a/cpu/stm32w108/hal/micro/cortexm3/stm32w108/board.h b/cpu/stm32w108/hal/micro/cortexm3/stm32w108/board.h
@@ -1,4 +1,4 @@
-/** @file board.h
+/** @file cpu/stm32w108/hal/micro/cortexm3/stm32w108/board.h
  * @brief Header file x STM32W108 Kits boards abstraction.
  * See @ref board for documentation.
  *

diff --git a/cpu/stm32w108/hal/micro/cortexm3/temperature-sensor.c b/cpu/stm32w108/hal/micro/cortexm3/temperature-sensor.c
@@ -1,5 +1,5 @@
-/**@file temperature-sensor.c
- * @brief MB851 temperature sensor APIS 
+/**@file cpu/stm32w108/hal/micro/cortexm3/temperature-sensor.c
+ * @brief MB851 temperature sensor APIS
  *
  *
  * <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved.        -->

diff --git a/cpu/stm32w108/hal/micro/mems.h b/cpu/stm32w108/hal/micro/mems.h
@@ -1,5 +1,5 @@
-/** @file mems.h
- * @brief Header for MB851 mems APIS 
+/** @file cpu/stm32w108/hal/micro/mems.h
+ * @brief Header for MB851 mems APIS
  *
  *
  * <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved.        -->

diff --git a/cpu/stm32w108/hal/micro/micro-common.h b/cpu/stm32w108/hal/micro/micro-common.h
@@ -1,10 +1,10 @@
-/** @file micro-common.h
+/** @file cpu/stm32w108/hal/micro/micro-common.h
  * @brief Minimal Hal functions common across all microcontroller-specific files.
  * See @ref micro for documentation.
  *
  * <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved.        -->
  */
- 
+
 /** @addtogroup micro
  * Many of the supplied example applications use these microcontroller functions.
  * See hal/micro/micro-common.h for source code.

diff --git a/cpu/stm32w108/hal/micro/system-timer.h b/cpu/stm32w108/hal/micro/system-timer.h
@@ -54,7 +54,7 @@ uint16_t halCommonGetInt16uMillisecondTick(void);
  * @brief Returns the current system time in system ticks, as a 32-bit
  * value.
  *
- * @nostackusage
+ * nostackusage
  *
  * @return The least significant 32 bits of the current system time, in
  * system ticks.
@@ -65,7 +65,7 @@ uint32_t halCommonGetInt32uMillisecondTick(void);
  * @brief Returns the current system time in quarter second ticks, as a
  * 16-bit value.
  *
- * @nostackusage
+ * nostackusage
  *
  * @return The least significant 16 bits of the current system time, in system
  * ticks multiplied by 256.

diff --git a/platform/avr-ravenusb/cdc_task.c b/platform/avr-ravenusb/cdc_task.c
@@ -1,5 +1,5 @@
 /* This file has been prepared for Doxygen automatic documentation generation.*/
-/*! \file cdc_task.c **********************************************************
+/*! \file platform/avr-ravenusb/cdc_task.c **********************************************************
  *
  * \brief
  *      Manages the CDC-ACM Virtual Serial Port Dataclass for the USB Device

diff --git a/platform/mbxxx/dev/eeprom.c b/platform/mbxxx/dev/eeprom.c
@@ -32,7 +32,7 @@
  */
 
 /**
- * \file  eeprom.c
+ * \file  platform/mbxxx/dev/eeprom.c
  * \brief ST M24C64W EEPROM driver.
  * \author Maria Laura Stefanizzi <[email protected]>
  * \date   2013-11-20

diff --git a/platform/mbxxx/dev/i2c.c b/platform/mbxxx/dev/i2c.c
@@ -32,7 +32,7 @@
  */
 
 /**
- * \file  i2c.c
+ * \file  platform/mbxxx/dev/i2c.c
  * \brief I2C bus master driver for mbxxx platform.
  * \author Maria Laura Stefanizzi <[email protected]>
  * \date   2013-11-20

diff --git a/platform/mbxxx/dev/i2c.h b/platform/mbxxx/dev/i2c.h
@@ -32,7 +32,7 @@
  */
 
 /**
- * \file  i2c.h
+ * \file  platform/mbxxx/dev/i2c.h
  * \brief I2C bus master driver for mbxxx platform.
  * \author Maria Laura Stefanizzi <[email protected]>
  * \date   2013-11-20

diff --git a/platform/seedeye/contiki-conf.h b/platform/seedeye/contiki-conf.h
@@ -35,7 +35,7 @@
  */
 
 /**
- * \file  contiki-conf.h
+ * \file  platform/seedeye/contiki-conf.h
  * \brief Contiki configuration file for the SEEDEYE port.
  * \author Giovanni Pellerano <[email protected]>
  * \date   2012-03-21