[doc] Various fixes for doxygen grouping etc.

2024-12-21 19:29:18 +00:00 · 2013-08-10 14:31:43 +02:00 · 2013-08-10 14:31:43 +02:00 · 0b8769e576
commit 0b8769e576
parent e4db33f560
20 changed files with 105 additions and 32 deletions
--- a/core/net/rime/broadcast-announcement.c
+++ b/core/net/rime/broadcast-announcement.c
@ -1,8 +1,3 @@
-/**
- * \addtogroup rimeexamples
- * @{
- */
-
 /*
 * Copyright (c) 2006, Swedish Institute of Computer Science.
 * All rights reserved.
@ -35,6 +30,11 @@
 *
 */

+/**
+ * \addtogroup rimeexamples
+ * @{
+ */
+
 /**
 * \file
 *         An example announcement back-end, based on the broadcast primitive
--- a/core/net/rime/broadcast.c
+++ b/core/net/rime/broadcast.c
@ -1,8 +1,3 @@
-/**
- * \addtogroup rimebroadcast
- * @{
- */
-
 /*
 * Copyright (c) 2006, Swedish Institute of Computer Science.
 * All rights reserved.
@ -35,6 +30,11 @@
 *
 */

+/**
+ * \addtogroup rimebroadcast
+ * @{
+ */
+
 /**
 * \file
 *         Identified best-effort local area broadcast (broadcast)
--- a/core/net/rime/multihop.c
+++ b/core/net/rime/multihop.c
@ -1,5 +1,5 @@
 /**
- * \addtogroup rimemh
+ * \addtogroup rime
 * @{
 */

--- a/cpu/avr/dev/lanc111.c
+++ b/cpu/avr/dev/lanc111.c
@ -167,9 +167,12 @@
 #endif

 /*!
- * \addtogroup xgSmscRegs
- */
-/*@{*/
+ * \addtogroup avr
+ * @{ */
+/*!
+ * \defgroup xgSmscRegs
+ *
+ * @{ */

 /*!
 * \brief Bank select register.
@ -1361,3 +1364,6 @@ lanc111_init(void)
 }

 /** @} */
+/** @} */
+
+/** @} */
--- a/cpu/avr/dev/usb/config.h
+++ b/cpu/avr/dev/usb/config.h
@ -53,7 +53,7 @@
 #define CONFIG_H_

 /**
-   @addtogroup usb
+   @addtogroup usbstick
   @{
 */

--- a/cpu/avr/dev/usb/pll_drv.h
+++ b/cpu/avr/dev/usb/pll_drv.h
@ -55,7 +55,7 @@
 //_____ I N C L U D E S ____________________________________________________

 /**
-   @addtogroup usb
+   @addtogroup usbstick
   @{
 */
 //_____ M A C R O S ________________________________________________________
--- a/cpu/pic32/pic32.h
+++ b/cpu/pic32/pic32.h
@ -34,6 +34,10 @@
 *
 */

+/**
+ * \addtogroup cpu
+ * @{ */
+
 /**
 * \defgroup pic32 PIC32 Contiki Port
 *
--- a/cpu/stm32w108/hal/error-def.h
+++ b/cpu/stm32w108/hal/error-def.h
@ -7,7 +7,11 @@
 */

 /**
- * @addtogroup status_codes
+ * @addtogroup stm32w-cpu
+ * @{ */
+
+/**
+ * @defgroup status_codes
 *
 * Many StZNet API functions return an ::StStatus value to indicate
 * the success or failure of the call.
--- a/cpu/stm32w108/hal/micro/adc.h
+++ b/cpu/stm32w108/hal/micro/adc.h
@ -3,7 +3,12 @@
 *
 * <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved.        -->
 */
-/** @addtogroup adc
+
+/**
+ * @addtogroup stm32w-cpu
+ * @{ */
+
+/** @defgroup adc
 * Sample A/D converter driver.
 *
 * See adc.h for source code.
@ -318,5 +323,5 @@ boolean halAdcGetRange(void);

 /** @} // END addtogroup
 */
-
+/** @} */

--- a/cpu/stm32w108/hal/micro/cortexm3/compiler/gnu.h
+++ b/cpu/stm32w108/hal/micro/cortexm3/compiler/gnu.h
@ -3,7 +3,11 @@
 *
 */

-/** @addtogroup gnu
+/**
+ * @addtogroup stm32w-cpu
+ * @{ */
+
+/** @defgroup gnu
 * @brief Compiler and Platform specific definitions and typedefs for the
 *  GNU C ARM compiler.
 *
@ -539,4 +543,5 @@ int abs(int I);
 #endif // GNU_H_

 /** @}  END addtogroup */
+/** @} */

--- a/cpu/stm32w108/hal/micro/cortexm3/compiler/iar.h
+++ b/cpu/stm32w108/hal/micro/cortexm3/compiler/iar.h
@ -4,7 +4,11 @@
 * <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved.        -->
 */

-/** @addtogroup iar
+/**
+ * @addtogroup stm32w-cpu
+ * @{ */
+
+/** @defgroup iar
 * @brief Compiler and Platform specific definitions and typedefs for the
 *  IAR ARM C compiler.
 *
@ -532,4 +536,5 @@ int abs(int I);
 #endif // IAR_H_

 /** @}  END addtogroup */
+/** @} */

--- a/cpu/stm32w108/hal/micro/cortexm3/flash.h
+++ b/cpu/stm32w108/hal/micro/cortexm3/flash.h
@ -4,8 +4,13 @@
 * <!--(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
 * 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_

 /** @} END addtogroup */
+/** @} */

--- a/cpu/stm32w108/hal/micro/cortexm3/nvm.h
+++ b/cpu/stm32w108/hal/micro/cortexm3/nvm.h
@ -9,8 +9,12 @@
 *
 * <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved.        -->
 */
- 
-/** @addtogroup nvm
+
+/**
+ * @addtogroup stm32w-cpu
+ * @{ */
+
+/** @defgroup nvm
 * @brief Cortex-M3 Non-Volatile Memory data storage system.
 *
 * 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)

 /** @} END addtogroup */
+/** @} */

 #endif // NVM_H_

--- a/cpu/stm32w108/hal/micro/generic/compiler/platform-common.h
+++ b/cpu/stm32w108/hal/micro/generic/compiler/platform-common.h
@ -1,4 +1,4 @@
-/** \addtogroup platform_common
+/** 
 * \brief Compiler and Platform specific definitions and typedefs common to
 * all platforms.  
 *
@ -10,6 +10,10 @@
 *@{
 */

+/**
+ * @addtogroup stm32w-cpu
+ * @{ */
+
 /** \file hal/micro/generic/compiler/platform-common.h
 * See \ref platform_common for detailed documentation.
 *
@ -348,4 +352,5 @@
 #endif //PLATFORMCOMMON_H_

 /** @}  END addtogroup */
+/** @} */

--- a/cpu/stm32w108/hal/micro/led.h
+++ b/cpu/stm32w108/hal/micro/led.h
@ -4,7 +4,11 @@
 * <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved.        -->
 */

-/** @addtogroup led 
+/**
+ * @addtogroup stm32w-cpu
+ * @{ */
+
+/** @defgroup led 
 *  @brief  Sample API funtions for controlling LEDs.
 *
 * When specifying an LED to use, always use the BOARDLEDx definitions that
@ -55,4 +59,4 @@ void halClearLed(HalBoardLed led);

 /** @} // END addtogroup 
 */
-
+/** @} */
--- a/cpu/stm32w108/hal/micro/micro-common.h
+++ b/cpu/stm32w108/hal/micro/micro-common.h
@ -5,7 +5,11 @@
 * <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved.        -->
 */

-/** @addtogroup micro
+/**
+ * @addtogroup stm32w-cpu
+ * @{ */
+
+/** @defgroup micro
 * Many of the supplied example applications use these microcontroller functions.
 * 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_

 /** @} END micro group  */
+/** @} */

--- a/cpu/stm32w108/hal/micro/system-timer.h
+++ b/cpu/stm32w108/hal/micro/system-timer.h
@ -6,7 +6,11 @@

 */

-/** @addtogroup system_timer
+/**
+ * @addtogroup stm32w-cpu
+ * @{ */
+
+/** @defgroup system_timer
 * @brief Functions that provide access to the system clock.
 *
 * A single system tick (as returned by ::halCommonGetInt16uMillisecondTick() and
@ -76,7 +80,7 @@ uint16_t halCommonGetInt16uQuarterSecondTick(void);

 /**@} //END addtogroup
 */
-
+/** @} */



--- a/platform/mbxxx/platform-conf.h
+++ b/platform/mbxxx/platform-conf.h
@ -1,3 +1,6 @@
+/**
+ * \addtogroup platform
+ * @{ */
 /**
 * \defgroup mbxxx-platform The STM32W MBXXX platform.
 *
@ -102,3 +105,4 @@ typedef unsigned long rtimer_clock_t;

 #endif /* PLATFORM_CONF_H_ */
 /** @} */
+/** @} */
--- a/platform/seedeye/contiki-seedeye-main.c
+++ b/platform/seedeye/contiki-seedeye-main.c
@ -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)
 /*---------------------------------------------------------------------------*/

 /** @} */
+/** @} */
+
--- a/platform/seedeye/dev/mrf24j40/mrf24j40.h
+++ b/platform/seedeye/dev/mrf24j40/mrf24j40.h
@ -34,6 +34,10 @@
 *
 */

+/**
+ * \addtogroup SeedEye 
+ * @{ */
+
 /**
 * \defgroup mrf24j40 MRF24J40 Driver
 *
@ -226,3 +230,4 @@ typedef union _INT_status {
 #endif /* MRF24J40_H_ */

 /** @} */
+/** @} */