[doc] Various fixes for doxygen grouping etc.
This commit is contained in:
parent
e4db33f560
commit
0b8769e576
|
@ -1,8 +1,3 @@
|
||||||
/**
|
|
||||||
* \addtogroup rimeexamples
|
|
||||||
* @{
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Copyright (c) 2006, Swedish Institute of Computer Science.
|
* Copyright (c) 2006, Swedish Institute of Computer Science.
|
||||||
* All rights reserved.
|
* All rights reserved.
|
||||||
|
@ -35,6 +30,11 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \addtogroup rimeexamples
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \file
|
* \file
|
||||||
* An example announcement back-end, based on the broadcast primitive
|
* An example announcement back-end, based on the broadcast primitive
|
||||||
|
|
|
@ -1,8 +1,3 @@
|
||||||
/**
|
|
||||||
* \addtogroup rimebroadcast
|
|
||||||
* @{
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Copyright (c) 2006, Swedish Institute of Computer Science.
|
* Copyright (c) 2006, Swedish Institute of Computer Science.
|
||||||
* All rights reserved.
|
* All rights reserved.
|
||||||
|
@ -35,6 +30,11 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \addtogroup rimebroadcast
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \file
|
* \file
|
||||||
* Identified best-effort local area broadcast (broadcast)
|
* Identified best-effort local area broadcast (broadcast)
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/**
|
/**
|
||||||
* \addtogroup rimemh
|
* \addtogroup rime
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -167,9 +167,12 @@
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
* \addtogroup xgSmscRegs
|
* \addtogroup avr
|
||||||
*/
|
* @{ */
|
||||||
/*@{*/
|
/*!
|
||||||
|
* \defgroup xgSmscRegs
|
||||||
|
*
|
||||||
|
* @{ */
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
* \brief Bank select register.
|
* \brief Bank select register.
|
||||||
|
@ -1361,3 +1364,6 @@ lanc111_init(void)
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @} */
|
/** @} */
|
||||||
|
/** @} */
|
||||||
|
|
||||||
|
/** @} */
|
||||||
|
|
|
@ -53,7 +53,7 @@
|
||||||
#define CONFIG_H_
|
#define CONFIG_H_
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@addtogroup usb
|
@addtogroup usbstick
|
||||||
@{
|
@{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -55,7 +55,7 @@
|
||||||
//_____ I N C L U D E S ____________________________________________________
|
//_____ I N C L U D E S ____________________________________________________
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@addtogroup usb
|
@addtogroup usbstick
|
||||||
@{
|
@{
|
||||||
*/
|
*/
|
||||||
//_____ M A C R O S ________________________________________________________
|
//_____ M A C R O S ________________________________________________________
|
||||||
|
|
|
@ -34,6 +34,10 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \addtogroup cpu
|
||||||
|
* @{ */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \defgroup pic32 PIC32 Contiki Port
|
* \defgroup pic32 PIC32 Contiki Port
|
||||||
*
|
*
|
||||||
|
|
|
@ -7,7 +7,11 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @addtogroup status_codes
|
* @addtogroup stm32w-cpu
|
||||||
|
* @{ */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup status_codes
|
||||||
*
|
*
|
||||||
* Many StZNet API functions return an ::StStatus value to indicate
|
* Many StZNet API functions return an ::StStatus value to indicate
|
||||||
* the success or failure of the call.
|
* the success or failure of the call.
|
||||||
|
|
|
@ -3,7 +3,12 @@
|
||||||
*
|
*
|
||||||
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
||||||
*/
|
*/
|
||||||
/** @addtogroup adc
|
|
||||||
|
/**
|
||||||
|
* @addtogroup stm32w-cpu
|
||||||
|
* @{ */
|
||||||
|
|
||||||
|
/** @defgroup adc
|
||||||
* Sample A/D converter driver.
|
* Sample A/D converter driver.
|
||||||
*
|
*
|
||||||
* See adc.h for source code.
|
* See adc.h for source code.
|
||||||
|
@ -318,5 +323,5 @@ boolean halAdcGetRange(void);
|
||||||
|
|
||||||
/** @} // END addtogroup
|
/** @} // END addtogroup
|
||||||
*/
|
*/
|
||||||
|
/** @} */
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,11 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** @addtogroup gnu
|
/**
|
||||||
|
* @addtogroup stm32w-cpu
|
||||||
|
* @{ */
|
||||||
|
|
||||||
|
/** @defgroup gnu
|
||||||
* @brief Compiler and Platform specific definitions and typedefs for the
|
* @brief Compiler and Platform specific definitions and typedefs for the
|
||||||
* GNU C ARM compiler.
|
* GNU C ARM compiler.
|
||||||
*
|
*
|
||||||
|
@ -539,4 +543,5 @@ int abs(int I);
|
||||||
#endif // GNU_H_
|
#endif // GNU_H_
|
||||||
|
|
||||||
/** @} END addtogroup */
|
/** @} END addtogroup */
|
||||||
|
/** @} */
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,11 @@
|
||||||
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** @addtogroup iar
|
/**
|
||||||
|
* @addtogroup stm32w-cpu
|
||||||
|
* @{ */
|
||||||
|
|
||||||
|
/** @defgroup iar
|
||||||
* @brief Compiler and Platform specific definitions and typedefs for the
|
* @brief Compiler and Platform specific definitions and typedefs for the
|
||||||
* IAR ARM C compiler.
|
* IAR ARM C compiler.
|
||||||
*
|
*
|
||||||
|
@ -532,4 +536,5 @@ int abs(int I);
|
||||||
#endif // IAR_H_
|
#endif // IAR_H_
|
||||||
|
|
||||||
/** @} END addtogroup */
|
/** @} END addtogroup */
|
||||||
|
/** @} */
|
||||||
|
|
||||||
|
|
|
@ -4,8 +4,13 @@
|
||||||
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** @addtogroup flash
|
/**
|
||||||
* @brief Definition and description of public flash manipulation routines.
|
* \addtogroup stm32w-cpu
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup flash Definition and description of public flash manipulation routines.
|
||||||
*
|
*
|
||||||
* @note
|
* @note
|
||||||
* During an erase or a write the flash is not available,
|
* During an erase or a write the flash is not available,
|
||||||
|
@ -123,4 +128,5 @@ StStatus halInternalCibOptionByteWrite(uint8_t byte, uint8_t data);
|
||||||
#endif //FLASH_H_
|
#endif //FLASH_H_
|
||||||
|
|
||||||
/** @} END addtogroup */
|
/** @} END addtogroup */
|
||||||
|
/** @} */
|
||||||
|
|
||||||
|
|
|
@ -9,8 +9,12 @@
|
||||||
*
|
*
|
||||||
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** @addtogroup nvm
|
/**
|
||||||
|
* @addtogroup stm32w-cpu
|
||||||
|
* @{ */
|
||||||
|
|
||||||
|
/** @defgroup nvm
|
||||||
* @brief Cortex-M3 Non-Volatile Memory data storage system.
|
* @brief Cortex-M3 Non-Volatile Memory data storage system.
|
||||||
*
|
*
|
||||||
* This header defines the API for NVM data storage. This header also
|
* This header defines the API for NVM data storage. This header also
|
||||||
|
@ -274,6 +278,7 @@ StStatus halCommonWriteToNvm(const void *data, uint32_t offset, uint16_t length)
|
||||||
#define NVM_MGMT_SIZE_B (4)
|
#define NVM_MGMT_SIZE_B (4)
|
||||||
|
|
||||||
/** @} END addtogroup */
|
/** @} END addtogroup */
|
||||||
|
/** @} */
|
||||||
|
|
||||||
#endif // NVM_H_
|
#endif // NVM_H_
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
/** \addtogroup platform_common
|
/**
|
||||||
* \brief Compiler and Platform specific definitions and typedefs common to
|
* \brief Compiler and Platform specific definitions and typedefs common to
|
||||||
* all platforms.
|
* all platforms.
|
||||||
*
|
*
|
||||||
|
@ -10,6 +10,10 @@
|
||||||
*@{
|
*@{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @addtogroup stm32w-cpu
|
||||||
|
* @{ */
|
||||||
|
|
||||||
/** \file hal/micro/generic/compiler/platform-common.h
|
/** \file hal/micro/generic/compiler/platform-common.h
|
||||||
* See \ref platform_common for detailed documentation.
|
* See \ref platform_common for detailed documentation.
|
||||||
*
|
*
|
||||||
|
@ -348,4 +352,5 @@
|
||||||
#endif //PLATFORMCOMMON_H_
|
#endif //PLATFORMCOMMON_H_
|
||||||
|
|
||||||
/** @} END addtogroup */
|
/** @} END addtogroup */
|
||||||
|
/** @} */
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,11 @@
|
||||||
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** @addtogroup led
|
/**
|
||||||
|
* @addtogroup stm32w-cpu
|
||||||
|
* @{ */
|
||||||
|
|
||||||
|
/** @defgroup led
|
||||||
* @brief Sample API funtions for controlling LEDs.
|
* @brief Sample API funtions for controlling LEDs.
|
||||||
*
|
*
|
||||||
* When specifying an LED to use, always use the BOARDLEDx definitions that
|
* When specifying an LED to use, always use the BOARDLEDx definitions that
|
||||||
|
@ -55,4 +59,4 @@ void halClearLed(HalBoardLed led);
|
||||||
|
|
||||||
/** @} // END addtogroup
|
/** @} // END addtogroup
|
||||||
*/
|
*/
|
||||||
|
/** @} */
|
||||||
|
|
|
@ -5,7 +5,11 @@
|
||||||
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** @addtogroup micro
|
/**
|
||||||
|
* @addtogroup stm32w-cpu
|
||||||
|
* @{ */
|
||||||
|
|
||||||
|
/** @defgroup micro
|
||||||
* Many of the supplied example applications use these microcontroller functions.
|
* Many of the supplied example applications use these microcontroller functions.
|
||||||
* See hal/micro/micro-common.h for source code.
|
* See hal/micro/micro-common.h for source code.
|
||||||
*
|
*
|
||||||
|
@ -144,4 +148,5 @@ StStatus halBootloaderStart(uint8_t mode, uint8_t channel, uint16_t panId);
|
||||||
#endif //MICRO_COMMON_H_
|
#endif //MICRO_COMMON_H_
|
||||||
|
|
||||||
/** @} END micro group */
|
/** @} END micro group */
|
||||||
|
/** @} */
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,11 @@
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** @addtogroup system_timer
|
/**
|
||||||
|
* @addtogroup stm32w-cpu
|
||||||
|
* @{ */
|
||||||
|
|
||||||
|
/** @defgroup system_timer
|
||||||
* @brief Functions that provide access to the system clock.
|
* @brief Functions that provide access to the system clock.
|
||||||
*
|
*
|
||||||
* A single system tick (as returned by ::halCommonGetInt16uMillisecondTick() and
|
* A single system tick (as returned by ::halCommonGetInt16uMillisecondTick() and
|
||||||
|
@ -76,7 +80,7 @@ uint16_t halCommonGetInt16uQuarterSecondTick(void);
|
||||||
|
|
||||||
/**@} //END addtogroup
|
/**@} //END addtogroup
|
||||||
*/
|
*/
|
||||||
|
/** @} */
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,6 @@
|
||||||
|
/**
|
||||||
|
* \addtogroup platform
|
||||||
|
* @{ */
|
||||||
/**
|
/**
|
||||||
* \defgroup mbxxx-platform The STM32W MBXXX platform.
|
* \defgroup mbxxx-platform The STM32W MBXXX platform.
|
||||||
*
|
*
|
||||||
|
@ -102,3 +105,4 @@ typedef unsigned long rtimer_clock_t;
|
||||||
|
|
||||||
#endif /* PLATFORM_CONF_H_ */
|
#endif /* PLATFORM_CONF_H_ */
|
||||||
/** @} */
|
/** @} */
|
||||||
|
/** @} */
|
||||||
|
|
|
@ -35,7 +35,11 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \addtogroup SeedEye Contiki SEEDEYE Platform
|
* \addtogroup platform
|
||||||
|
* @{ */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \defgroup SeedEye Contiki SEEDEYE Platform
|
||||||
*
|
*
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
@ -178,3 +182,5 @@ main(int argc, char **argv)
|
||||||
/*---------------------------------------------------------------------------*/
|
/*---------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/** @} */
|
/** @} */
|
||||||
|
/** @} */
|
||||||
|
|
||||||
|
|
|
@ -34,6 +34,10 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \addtogroup SeedEye
|
||||||
|
* @{ */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \defgroup mrf24j40 MRF24J40 Driver
|
* \defgroup mrf24j40 MRF24J40 Driver
|
||||||
*
|
*
|
||||||
|
@ -226,3 +230,4 @@ typedef union _INT_status {
|
||||||
#endif /* MRF24J40_H_ */
|
#endif /* MRF24J40_H_ */
|
||||||
|
|
||||||
/** @} */
|
/** @} */
|
||||||
|
/** @} */
|
||||||
|
|
Loading…
Reference in a new issue