diff --git a/cpu/arm/common/CMSIS/core.txt b/cpu/arm/common/CMSIS/core.txt index 3ae0d00ff..b9270e199 100644 --- a/cpu/arm/common/CMSIS/core.txt +++ b/cpu/arm/common/CMSIS/core.txt @@ -34,17 +34,17 @@ */ /** - * @defgroup Cortex_M0 + * @defgroup Cortex_M0 Cortex-M0 * @ingroup cmsis */ /** - * @defgroup Cortex_M3 + * @defgroup Cortex_M3 Cortex-M3 * @ingroup cmsis */ /** - * @defgroup Cortex_M4 + * @defgroup Cortex_M4 Cortex-M4 * @ingroup cmsis */ diff --git a/cpu/avr/dev/lanc111.c b/cpu/avr/dev/lanc111.c index 28b793896..60cde63af 100644 --- a/cpu/avr/dev/lanc111.c +++ b/cpu/avr/dev/lanc111.c @@ -170,7 +170,7 @@ * \addtogroup avr * @{ */ /*! - * \defgroup xgSmscRegs + * \defgroup xgSmscRegs SMSC Registers * * @{ */ @@ -1203,6 +1203,7 @@ PROCESS_THREAD(lanc111_process, ev, data) PROCESS_END(); } #endif /* 0 */ +#if 0 /*! * \brief Send Ethernet packet. * @@ -1213,7 +1214,6 @@ PROCESS_THREAD(lanc111_process, ev, data) * * \return 0 on success, -1 in case of any errors. */ -#if 0 int LancOutput(NUTDEVICE * dev, NETBUF * nb) { static u_long mx_wait = 5000; diff --git a/cpu/avr/radio/rf230bb/halbb.c b/cpu/avr/radio/rf230bb/halbb.c index 53deb1c8a..5cd920a39 100644 --- a/cpu/avr/radio/rf230bb/halbb.c +++ b/cpu/avr/radio/rf230bb/halbb.c @@ -544,6 +544,7 @@ hal_frame_write(uint8_t *write_buffer, uint8_t length) } /*----------------------------------------------------------------------------*/ +#if 0 //Uses 80 bytes (on Raven) omit unless needed /** \brief Read SRAM * * This function reads from the SRAM of the radio transceiver. @@ -552,7 +553,6 @@ hal_frame_write(uint8_t *write_buffer, uint8_t length) * \param length Length of the read burst * \param data Pointer to buffer where data is stored. */ -#if 0 //Uses 80 bytes (on Raven) omit unless needed void hal_sram_read(uint8_t address, uint8_t length, uint8_t *data) { @@ -576,6 +576,7 @@ hal_sram_read(uint8_t address, uint8_t length, uint8_t *data) } #endif /*----------------------------------------------------------------------------*/ +#if 0 //omit unless needed /** \brief Write SRAM * * This function writes into the SRAM of the radio transceiver. It can reduce @@ -585,7 +586,6 @@ hal_sram_read(uint8_t address, uint8_t length, uint8_t *data) * \param length Length of the write burst * \param data Pointer to an array of bytes that should be written */ -#if 0 //omit unless needed void hal_sram_write(uint8_t address, uint8_t length, uint8_t *data) { diff --git a/cpu/stm32w108/hal/error-def.h b/cpu/stm32w108/hal/error-def.h index 908b60ae5..9295f7115 100644 --- a/cpu/stm32w108/hal/error-def.h +++ b/cpu/stm32w108/hal/error-def.h @@ -486,7 +486,7 @@ DEFINE_ERROR(ERR_FLASH_VERIFY_FAILED, 0x47) #ifdef DOXYGEN_SHOULD_SKIP_THIS /** - * @description A fatal error has occured while trying to write data to the + * @brief A fatal error has occured while trying to write data to the * flash, possibly due to write protection or an invalid address. The data in * the flash cannot be trusted after this error, and it is possible this error * is the result of exceeding the life cycles of the flash. @@ -499,7 +499,7 @@ DEFINE_ERROR(ERR_FLASH_PROG_FAIL, 0x4B) #ifdef DOXYGEN_SHOULD_SKIP_THIS /** - * @description A fatal error has occured while trying to erase flash, possibly + * @brief A fatal error has occured while trying to erase flash, possibly * due to write protection. The data in the flash cannot be trusted after * this error, and it is possible this error is the result of exceeding the * life cycles of the flash. @@ -1274,7 +1274,9 @@ DEFINE_ERROR( APPLICATION_ERROR_14, 0xFE) DEFINE_ERROR( APPLICATION_ERROR_15, 0xFF) #endif //DOXYGEN_SHOULD_SKIP_THIS -/** @} */ // END name group +/** @} */ + +/** @} END defgroup */ /** @} END addtogroup */ diff --git a/cpu/stm32w108/hal/micro/cortexm3/compiler/gnu.h b/cpu/stm32w108/hal/micro/cortexm3/compiler/gnu.h index 7783c0f96..ccdfa6199 100644 --- a/cpu/stm32w108/hal/micro/cortexm3/compiler/gnu.h +++ b/cpu/stm32w108/hal/micro/cortexm3/compiler/gnu.h @@ -7,7 +7,7 @@ * @addtogroup stm32w-cpu * @{ */ -/** @defgroup gnu +/** @defgroup gnu GNU * @brief Compiler and Platform specific definitions and typedefs for the * GNU C ARM compiler. * diff --git a/cpu/stm32w108/hal/micro/cortexm3/compiler/iar.h b/cpu/stm32w108/hal/micro/cortexm3/compiler/iar.h index c4492dd61..a057d48ca 100644 --- a/cpu/stm32w108/hal/micro/cortexm3/compiler/iar.h +++ b/cpu/stm32w108/hal/micro/cortexm3/compiler/iar.h @@ -8,7 +8,7 @@ * @addtogroup stm32w-cpu * @{ */ -/** @defgroup iar +/** @defgroup iar IAR * @brief Compiler and Platform specific definitions and typedefs for the * IAR ARM C compiler. * diff --git a/cpu/stm32w108/hal/micro/micro-common.h b/cpu/stm32w108/hal/micro/micro-common.h index db12908bf..9cba68903 100644 --- a/cpu/stm32w108/hal/micro/micro-common.h +++ b/cpu/stm32w108/hal/micro/micro-common.h @@ -9,7 +9,7 @@ * @addtogroup stm32w-cpu * @{ */ -/** @defgroup micro +/** @defgroup micro Micro * Many of the supplied example applications use these microcontroller functions. * See hal/micro/micro-common.h for source code. * diff --git a/doc/Doxyfile b/doc/Doxyfile index a9c714d73..cd0d1ac7c 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -1918,14 +1918,14 @@ MACRO_EXPANSION = YES # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -EXPAND_ONLY_PREDEF = NO +EXPAND_ONLY_PREDEF = YES # If the SEARCH_INCLUDES tag is set to YES the includes files in the # INCLUDE_PATH will be searched if a #include is found. # The default value is: YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -SEARCH_INCLUDES = YES +SEARCH_INCLUDES = NO # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by the @@ -1950,17 +1950,23 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = CC_FUNCTION_POINTER_ARGS \ - NETSTACK_CONF_WITH_RIME \ - NETSTACK_CONF_WITH_IPV4 \ - NETSTACK_CONF_WITH_IPV6 \ - UIP_CONF_IPV6_RPL \ - UIP_TCP \ - UIP_UDP \ - UIP_CONF_ICMP6 \ - WITH_LOADER_ARCH \ - DOXYGEN \ - "ASCCMD(name, flags, args)=void CMD_ASCII(name)" +PREDEFINED = CC_FUNCTION_POINTER_ARGS:=1 \ + NETSTACK_CONF_WITH_RIME:=1 \ + NETSTACK_CONF_WITH_IPV4:=1 \ + NETSTACK_CONF_WITH_IPV6:=1 \ + UIP_CONF_IPV6_RPL:=1 \ + UIP_TCP:=1 \ + UIP_UDP:=1 \ + UIP_CONF_ICMP6:=1 \ + WITH_LOADER_ARCH:=1 \ + __attribute__(x):= \ + CC_ALIGN_ATTR(n):= \ + HTTPD_STRING_ATTR:= \ + PROGMEM:= \ + EEMEM:= \ + DOXYGEN:=1 \ + DOXYGEN_SHOULD_SKIP_THIS:=1 \ + "ASCCMD(name, flags, args):=void CMD_ASCII(name)" # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/regression-tests/00-doxygen/doxyerrors.cnt b/regression-tests/00-doxygen/doxyerrors.cnt index 360b9e4ba..a2ecc456e 100644 --- a/regression-tests/00-doxygen/doxyerrors.cnt +++ b/regression-tests/00-doxygen/doxyerrors.cnt @@ -1,2 +1 @@ -209 - +154