Correct several doxygen tags (\file)

This commit is contained in:
Rémy Léone 2014-06-19 14:30:33 +02:00
parent f111058472
commit 8c3fa17ec0
33 changed files with 73 additions and 75 deletions

View file

@ -2032,7 +2032,7 @@ CCIF extern uip_lladdr_t uip_lladdr;
(((a)->u8[12]) == 0xFF)) (((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* * both a and b are of type uip_ipaddr_t*
* */ * */
#define uip_create_solicited_node(a, b) \ #define uip_create_solicited_node(a, b) \

View file

@ -51,7 +51,7 @@
*/ */
/** /**
* \file lc.h * \file core/sys/lc.h
* Local continuations * Local continuations
* \author * \author
* Adam Dunkels <adam@sics.se> * Adam Dunkels <adam@sics.se>

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file clock.c * \file cpu/pic32/clock.c
* \brief Clock routines. * \brief Clock routines.
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \author Daniele Alessandrelli <d.alessandrelli@sssup.it> * \author Daniele Alessandrelli <d.alessandrelli@sssup.it>

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file debug-uart.h * \file cpu/pic32/debug-uart.h
* \brief Debug output redirection to uart. * \brief Debug output redirection to uart.
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-03-21 * \date 2012-03-21

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file debug-uart.h * \file cpu/pic32/debug-uart.h
* \brief Debug output redirection to uart. * \brief Debug output redirection to uart.
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-03-21 * \date 2012-03-21

View file

@ -35,7 +35,7 @@
*/ */
/** /**
* @file uart1.h * @file cpu/pic32/dev/uart1.h
* @brief UART1 routines * @brief UART1 routines
* @author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * @author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* *

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file mtarch.h * \file cpu/pic32/mtarch.h
* \brief Implementation of multithreading in PIC32. To be done. * \brief Implementation of multithreading in PIC32. To be done.
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-03-23 * \date 2012-03-23

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file mtarch.h * \file cpu/pic32/mtarch.h
* \brief PIC32MX initialization routines * \brief PIC32MX initialization routines
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \author Daniele Alessandrelli <d.alessandrelli@sssup.it> * \author Daniele Alessandrelli <d.alessandrelli@sssup.it>

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file rtimer-arch.c * \file cpu/pic32/rtimer-arch.c
* \brief PIC32MX RTIMER routines * \brief PIC32MX RTIMER routines
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-04-11 * \date 2012-04-11

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file rtimer-arch.h * \file cpu/pic32/rtimer-arch.h
* \brief PIC32MX RTIMER routines * \brief PIC32MX RTIMER routines
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-04-11 * \date 2012-04-11

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file watchdog.c * \file cpu/pic32/watchdog.c
* \brief PIC32MX Watchdog routines * \brief PIC32MX Watchdog routines
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-03-23 * \date 2012-03-23

View file

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

View file

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

View file

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

View file

@ -1,5 +1,5 @@
/** @file hal/micro/cortexm3/mfg-token.h /** \file cpu/stm32w108/hal/micro/cortexm3/mfg-token.h
* @brief Cortex-M3 Manufacturing token system * \brief Cortex-M3 Manufacturing token system
* *
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. --> * <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
*/ */
@ -16,77 +16,77 @@
#define DEFINETOKENS #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 * 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) * 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. * will be stored. This parameter is generated with a macro above.
*/ */
#define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \ #define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \
extern const uint16_t TOKEN_##name; 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 #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. * 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,...) \ #define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \
TOKEN_##name##_SIZE = sizeof(type), TOKEN_##name##_SIZE = sizeof(type),
enum { enum {
#include "hal/micro/cortexm3/token-manufacturing.h" #include "cpu/stm32w108/hal/micro/cortexm3/token-manufacturing.h"
}; };
#undef TOKEN_MFG #undef TOKEN_MFG
#undef TOKEN_DEF #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. * 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 * This macro allows other macros below to use 'token##_TYPE' to declare
* a local copy of that token. * 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,...) \ #define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \
typedef type TOKEN_##name##_TYPE; 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_MFG
#undef TOKEN_NEXT_ADDRESS #undef TOKEN_NEXT_ADDRESS
#define DEFINEADDRESSES #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 * 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 * subsequent tokens to align against. ( See hal/micro/cortexm3/token.c for
* the instances of TOKEN_NEXT_ADDRESS() ); * 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) \ #define TOKEN_NEXT_ADDRESS(region, address) \
TOKEN_##region##_NEXT_ADDRESS = ((address) - 1), 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 * 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 * TOKEN_##name macro and provides the value passed into the internal token
* system calls. The END element is a placeholder providing the starting * system calls. The END element is a placeholder providing the starting
* point for the ADDRESS of the next dynamically positioned token. * 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). * for scalar tokens).
*/ */
#define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \ #define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \
@ -95,7 +95,7 @@
(TOKEN_##name##_SIZE * arraysize) - 1, (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. * an indentifier so the address of the top of the token system can be known.
*/ */
enum { enum {
@ -109,26 +109,26 @@ enum {
#ifndef DOXYGEN_SHOULD_SKIP_THIS #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 * location. This is the internal function that the exposed API
* (halCommonGetMfgToken) expands out to. The * (halCommonGetMfgToken) expands out to. The
* API simplifies the access into this function by hiding the size parameter. * 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. * 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. * 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. * 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); 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) * the internal function that the exposed API (halCommonSetMfgToken)
* expands out to. The API simplifies the access into this function * expands out to. The API simplifies the access into this function
* by hiding the size parameter. * 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 * <b>REMEMBER:</b> The flash hardware requires writing to 16bit aligned
* addresses with a length that is multiples of 16bits. * 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. * 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. * automatically set by the API to be the size of the token.
*/ */
void halInternalSetMfgTokenData(uint16_t token, void *data, uint8_t len); void halInternalSetMfgTokenData(uint16_t token, void *data, uint8_t len);

View file

@ -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 * to 48.5 days. Any sleep duration greater than this limit will wake up
* briefly (e.g. 16 microseconds) to reenable another sleep cycle. * briefly (e.g. 16 microseconds) to reenable another sleep cycle.
* *
* @nostackusage
*
* @param duration The amount of time, expressed in quarter seconds, that the * @param duration The amount of time, expressed in quarter seconds, that the
* micro should be placed into ::SLEEPMODE_WAKETIMER. When the function returns, * micro should be placed into ::SLEEPMODE_WAKETIMER. When the function returns,
* this parameter provides the amount of time remaining out of the original * this parameter provides the amount of time remaining out of the original

View file

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

View file

@ -1,4 +1,4 @@
/**@file temperature-sensor.c /**@file cpu/stm32w108/hal/micro/cortexm3/temperature-sensor.c
* @brief MB851 temperature sensor APIS * @brief MB851 temperature sensor APIS
* *
* *

View file

@ -1,4 +1,4 @@
/** @file mems.h /** @file cpu/stm32w108/hal/micro/mems.h
* @brief Header for MB851 mems APIS * @brief Header for MB851 mems APIS
* *
* *

View file

@ -1,4 +1,4 @@
/** @file micro-common.h /** @file cpu/stm32w108/hal/micro/micro-common.h
* @brief Minimal Hal functions common across all microcontroller-specific files. * @brief Minimal Hal functions common across all microcontroller-specific files.
* See @ref micro for documentation. * See @ref micro for documentation.
* *

View file

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

View file

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

View file

@ -32,7 +32,7 @@
*/ */
/** /**
* \file eeprom.c * \file platform/mbxxx/dev/eeprom.c
* \brief ST M24C64W EEPROM driver. * \brief ST M24C64W EEPROM driver.
* \author Maria Laura Stefanizzi <laura28582@gmail.com> * \author Maria Laura Stefanizzi <laura28582@gmail.com>
* \date 2013-11-20 * \date 2013-11-20

View file

@ -32,7 +32,7 @@
*/ */
/** /**
* \file i2c.c * \file platform/mbxxx/dev/i2c.c
* \brief I2C bus master driver for mbxxx platform. * \brief I2C bus master driver for mbxxx platform.
* \author Maria Laura Stefanizzi <laura28582@gmail.com> * \author Maria Laura Stefanizzi <laura28582@gmail.com>
* \date 2013-11-20 * \date 2013-11-20

View file

@ -32,7 +32,7 @@
*/ */
/** /**
* \file i2c.h * \file platform/mbxxx/dev/i2c.h
* \brief I2C bus master driver for mbxxx platform. * \brief I2C bus master driver for mbxxx platform.
* \author Maria Laura Stefanizzi <laura28582@gmail.com> * \author Maria Laura Stefanizzi <laura28582@gmail.com>
* \date 2013-11-20 * \date 2013-11-20

View file

@ -35,7 +35,7 @@
*/ */
/** /**
* \file contiki-conf.h * \file platform/seedeye/contiki-conf.h
* \brief Contiki configuration file for the SEEDEYE port. * \brief Contiki configuration file for the SEEDEYE port.
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-03-21 * \date 2012-03-21

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file battery-sensor.c * \file platform/seedeye/dev/battery-sensor.c
* \brief Battery Sensor * \brief Battery Sensor
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-07-04 * \date 2012-07-04

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file button-sensor.c * \file platform/seedeye/dev/button-sensor.c
* \brief Button Sensor * \brief Button Sensor
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-04-24 * \date 2012-04-24

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file leds-arch.c * \file platform/seedeye/dev/leds-arch.c
* \brief LEDs Specific Arch Conf * \brief LEDs Specific Arch Conf
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-03-21 * \date 2012-03-21

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file radio-sensor.c * \file platform/seedeye/dev/radio-sensor.c
* \brief RADIO Sensor * \brief RADIO Sensor
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-04-24 * \date 2012-04-24

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file init-net.c * \file platform/seedeye/init-net.c
* \brief Network initialization for the SEEDEYE port. * \brief Network initialization for the SEEDEYE port.
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-03-25 * \date 2012-03-25

View file

@ -41,7 +41,7 @@
*/ */
/** /**
* \file init-net.h * \file platform/seedeye/init-net.h
* \brief Network initialization for the SEEDEYE port. * \brief Network initialization for the SEEDEYE port.
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-03-25 * \date 2012-03-25

View file

@ -34,7 +34,7 @@
* *
*/ */
/** /**
* \file platform-conf.h * \file platform/seedeye/platform-conf.h
* \brief Platform configuration file for the SEEDEYE port. * \brief Platform configuration file for the SEEDEYE port.
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org> * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-06-06 * \date 2012-06-06