deac/osd-contiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #696 from sieben/doc

Browse source 
Correct several doxygen tags (\file,...)
This commit is contained in:
Nicolas Tsiftes 2014-07-28 11:42:41 +02:00
parent 95e2cd9021 8c3fa17ec0
commit 582bfcb8c6
35 changed files with 310 additions and 312 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
core/sys/lc.h
View file

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

2
cpu/pic32/clock.c
View file

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

2
cpu/pic32/debug-uart.c
View file

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

2
cpu/pic32/debug-uart.h
View file

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

2
cpu/pic32/dev/uart1.h
View file

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

2
cpu/pic32/mtarch.h
View file

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

2
cpu/pic32/pic32.c
View file

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

2
cpu/pic32/rtimer-arch.c
View file

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

2
cpu/pic32/rtimer-arch.h
View file

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

2
cpu/pic32/watchdog.c
View file

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

2
cpu/stm32w108/hal/error.h
View file

@ -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.

2
cpu/stm32w108/hal/micro/cortexm3/adc.c
View file

@ -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. -->

2
cpu/stm32w108/hal/micro/cortexm3/board.c
View file

@ -1,4 +1,4 @@
/** @file board.c
/** @file cpu/stm32w108/hal/micro/cortexm3/board.c
* @brief Board file x STM32W108 Kits boards
*
* This file implements a software layer to support all the ST kits boards

2
cpu/stm32w108/hal/micro/cortexm3/mems.c
View file

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

60
cpu/stm32w108/hal/micro/cortexm3/mfg-token.h
View file

@ -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
#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);

2
cpu/stm32w108/hal/micro/cortexm3/micro-common.h
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
* 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

2
cpu/stm32w108/hal/micro/cortexm3/stm32w108/board.h
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.
* See @ref board for documentation.
*

2
cpu/stm32w108/hal/micro/cortexm3/temperature-sensor.c
View file

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

2
cpu/stm32w108/hal/micro/mems.h
View file

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

2
cpu/stm32w108/hal/micro/micro-common.h
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.
* See @ref micro for documentation.
*

4
cpu/stm32w108/hal/micro/system-timer.h
View file

@ -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.

2
cpu/stm32w108/hal/micro/temperature-sensor.h
View file

@ -1,4 +1,4 @@
/** @file temperature-sensor.h
/** @file cpu/stm32w108/hal/micro/temperature-sensor.h
* @brief Header for temperature sensor driver
*
*

2
platform/avr-ravenusb/cdc_task.c
View file

@ -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

2
platform/mbxxx/dev/eeprom.c
View file

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

2
platform/mbxxx/dev/i2c.c
View file

@ -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 <laura28582@gmail.com>
* \date 2013-11-20

2
platform/mbxxx/dev/i2c.h
View file

@ -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 <laura28582@gmail.com>
* \date 2013-11-20

2
platform/seedeye/contiki-conf.h
View file

@ -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 <giovanni.pellerano@evilaliv3.org>
* \date 2012-03-21

2
platform/seedeye/dev/battery-sensor.c
View file

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

2
platform/seedeye/dev/button-sensor.c
View file

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

2
platform/seedeye/dev/leds-arch.c
View file

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

2
platform/seedeye/dev/radio-sensor.c
View file

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

2
platform/seedeye/init-net.c
View file

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

2
platform/seedeye/init-net.h
View file

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

2
platform/seedeye/platform-conf.h
View file

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