Apple-2-SW/contiki
1
0
Fork 0
mirror of https://github.com/oliverschmidt/contiki.git synced 2024-12-22 10:30:13 +00:00
Code Issues Projects Releases Wiki Activity

[cpu/stm32w108] Doxygen grouping and group name fixes

Browse Source
This commit is contained in:
Enrico Joerns 2014-10-07 00:09:09 +02:00
parent 198f52d2f8
commit cfbd4d49bf
3 changed files with 56 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
cpu/stm32w108/hal/error-def.h
View File

@ -11,7 +11,7 @@
* @{ */
/**
* @defgroup status_codes
* @defgroup status_codes Status Codes
*
* Many StZNet API functions return an ::StStatus value to indicate
* the success or failure of the call.
@ -34,8 +34,9 @@
/**
* @name Generic Messages
* These messages are system wide.
*
* @{
*/
//@{
#ifdef DOXYGEN_SHOULD_SKIP_THIS
/**
@ -110,13 +111,14 @@ DEFINE_ERROR(EEPROM_MFG_VERSION_MISMATCH, 0x06)
DEFINE_ERROR(EEPROM_STACK_VERSION_MISMATCH, 0x07)
#endif //DOXYGEN_SHOULD_SKIP_THIS
//@} // END Generic Messages
/** @} */ // END Generic Messages
/**
* @name Packet Buffer Module Errors
*
* @{
*/
//@{
#ifdef DOXYGEN_SHOULD_SKIP_THIS
/**
@ -127,12 +129,13 @@ DEFINE_ERROR(EEPROM_STACK_VERSION_MISMATCH, 0x07)
DEFINE_ERROR(NO_BUFFERS, 0x18)
#endif //DOXYGEN_SHOULD_SKIP_THIS
//@} / END Packet Buffer Module Errors
/** @} */ // END Packet Buffer Module Errors
/**
* @name Serial Manager Errors
*
* @{
*/
//@{
#ifdef DOXYGEN_SHOULD_SKIP_THIS
/**
@ -215,12 +218,13 @@ DEFINE_ERROR(SERIAL_RX_EMPTY, 0x26)
DEFINE_ERROR(SERIAL_RX_OVERRUN_ERROR, 0x27)
#endif //DOXYGEN_SHOULD_SKIP_THIS
//@}
/** @} */
/**
* @name MAC Errors
*/
//@{
*
* @{
*/
#ifdef DOXYGEN_SHOULD_SKIP_THIS
/**
@ -345,13 +349,14 @@ DEFINE_ERROR(MAC_NO_ACK_RECEIVED, 0x40)
DEFINE_ERROR(MAC_INDIRECT_TIMEOUT, 0x42)
#endif //DOXYGEN_SHOULD_SKIP_THIS
//@}
/** @} */
/**
* @name Simulated EEPROM Errors
*/
//@{
*
* @{
*/
#ifdef DOXYGEN_SHOULD_SKIP_THIS
@ -444,13 +449,13 @@ DEFINE_ERROR(SIM_EEPROM_INIT_2_FAILED, 0x49)
DEFINE_ERROR(SIM_EEPROM_INIT_3_FAILED, 0x4A)
#endif //DOXYGEN_SHOULD_SKIP_THIS
//@}
/** @} */
/**
* @name Flash Errors
*/
//@{
*
* @{ */
#ifdef DOXYGEN_SHOULD_SKIP_THIS
/**
@ -504,13 +509,14 @@ DEFINE_ERROR(ERR_FLASH_PROG_FAIL, 0x4B)
DEFINE_ERROR(ERR_FLASH_ERASE_FAIL, 0x4C)
#endif //DOXYGEN_SHOULD_SKIP_THIS
//@}
/** @} */
/**
* @name Bootloader Errors
*/
//@{
*
* @{
*/
#ifdef DOXYGEN_SHOULD_SKIP_THIS
@ -545,13 +551,14 @@ DEFINE_ERROR(ERR_BOOTLOADER_TRAP_UNKNOWN, 0x59)
DEFINE_ERROR(ERR_BOOTLOADER_NO_IMAGE, 0x5A)
#endif //DOXYGEN_SHOULD_SKIP_THIS
//@}
/** @} */
/**
* @name Transport Errors
*/
//@{
*
* @{
*/
#ifdef DOXYGEN_SHOULD_SKIP_THIS
/**
@ -657,12 +664,13 @@ DEFINE_ERROR(BINDING_IS_ACTIVE, 0x75)
DEFINE_ERROR(ADDRESS_TABLE_ENTRY_IS_ACTIVE, 0x76)
#endif //DOXYGEN_SHOULD_SKIP_THIS
//@}
/** @} */
/**
* @name HAL Module Errors
*/
//@{
*
* @{
*/
#ifdef DOXYGEN_SHOULD_SKIP_THIS
@ -717,12 +725,13 @@ DEFINE_ERROR(ADC_NO_CONVERSION_PENDING, 0x84)
DEFINE_ERROR(SLEEP_INTERRUPTED, 0x85)
#endif //DOXYGEN_SHOULD_SKIP_THIS
//@}
/** @} */
/**
* @name PHY Errors
*/
//@{
*
* @{
*/
#ifdef DOXYGEN_SHOULD_SKIP_THIS
@ -807,13 +816,14 @@ DEFINE_ERROR(PHY_OSCILLATOR_CHECK_FAILED, 0x8E)
DEFINE_ERROR(PHY_ACK_RECEIVED, 0x8F)
#endif //DOXYGEN_SHOULD_SKIP_THIS
//@}
/** @} */
/**
* @name Return Codes Passed to stStackStatusHandler()
* See also ::stStackStatusHandler().
*
* @{
*/
//@{
#ifdef DOXYGEN_SHOULD_SKIP_THIS
@ -949,10 +959,12 @@ DEFINE_ERROR(PRECONFIGURED_KEY_REQUIRED, 0xAF)
#endif
//@}
/** @} */
/**
* @name Security Errors
*
* @{
*/
#ifdef DOXYGEN_SHOULD_SKIP_THIS
/**
@ -1061,14 +1073,14 @@ DEFINE_ERROR(SECURITY_CONFIGURATION_INVALID, 0xB7)
#endif
//@}
/** @} */
/**
* @name Miscellaneous Network Errors
*/
//@{
*
* @{
*/
#ifdef DOXYGEN_SHOULD_SKIP_THIS
/**
@ -1143,13 +1155,13 @@ DEFINE_ERROR(BINDING_HAS_CHANGED, 0xA4)
#endif
//@}
/** @} */
/**
* @name Miscellaneous Utility Errors
*/
//@{
*
* @{
*/
#ifdef DOXYGEN_SHOULD_SKIP_THIS
/**
@ -1213,13 +1225,14 @@ DEFINE_ERROR(LIBRARY_NOT_PRESENT, 0xB5)
DEFINE_ERROR(OPERATION_IN_PROGRESS, 0xBA)
#endif
//@}
/** @} */
/**
* @name Application Errors
* These error codes are available for application use.
*
* @{
*/
//@{
#ifdef DOXYGEN_SHOULD_SKIP_THIS
/**
@ -1261,7 +1274,7 @@ DEFINE_ERROR( APPLICATION_ERROR_14, 0xFE)
DEFINE_ERROR( APPLICATION_ERROR_15, 0xFF)
#endif //DOXYGEN_SHOULD_SKIP_THIS
//@} // END name group
/** @} */ // END name group
/** @} END addtogroup */

3
cpu/stm32w108/hal/micro/adc.h
View File

@ -8,8 +8,7 @@
* @addtogroup stm32w-cpu
* @{ */
/** @defgroup adc
* Sample A/D converter driver.
/** @defgroup adc Sample A/D converter driver.
*
* See adc.h for source code.
*

3
cpu/stm32w108/hal/micro/led.h
View File

@ -8,8 +8,7 @@
* @addtogroup stm32w-cpu
* @{ */
/** @defgroup led
* @brief Sample API funtions for controlling LEDs.
/** @defgroup led Sample API funtions for controlling LEDs.
*
* When specifying an LED to use, always use the BOARDLEDx definitions that
* are defined within the BOARD_HEADER.