diff --git a/arch/arc/core/atomic.S b/arch/arc/core/atomic.S index f9441de03b8..1a3b5ecb751 100644 --- a/arch/arc/core/atomic.S +++ b/arch/arc/core/atomic.S @@ -1,5 +1,3 @@ -/* armAtomic.S - ARC atomic operations library */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,11 +14,13 @@ * limitations under the License. */ -/* -DESCRIPTION -This library provides routines to perform a number of atomic operations -on a memory location: add, subtract, increment, decrement, bitwise OR, -bitwise NOR, bitwise AND, bitwise NAND, set, clear and compare-and-swap. +/** + * @file + * @brief ARC atomic operations library + * + * This library provides routines to perform a number of atomic operations + * on a memory location: add, subtract, increment, decrement, bitwise OR, + * bitwise NOR, bitwise AND, bitwise NAND, set, clear and compare-and-swap. */ #define _ASMLANGUAGE diff --git a/arch/arc/core/cpu_idle.S b/arch/arc/core/cpu_idle.S index 4b1a1742759..8b94eba0ecf 100644 --- a/arch/arc/core/cpu_idle.S +++ b/arch/arc/core/cpu_idle.S @@ -1,5 +1,3 @@ -/* cpu_idle.S - CPU power management */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,9 +14,11 @@ * limitations under the License. */ -/* -DESCRIPTION -CPU power management routines. +/** + * @file + * @brief CPU power management + * + * CPU power management routines. */ #define _ASMLANGUAGE diff --git a/arch/arc/core/fast_irq.S b/arch/arc/core/fast_irq.S index 9a82b22fc33..f41d5f0e01d 100644 --- a/arch/arc/core/fast_irq.S +++ b/arch/arc/core/fast_irq.S @@ -1,5 +1,3 @@ -/* fast_irq.S - handling of transitions to-and-from fast IRQs (FIRQ) */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,11 +14,13 @@ * limitations under the License. */ -/* -DESCRIPTION -This module implements the code for handling entry to and exit from Fast IRQs. - -See isr_wrapper.S for details. +/** + * @file + * @brief Handling of transitions to-and-from fast IRQs (FIRQ) + * + * This module implements the code for handling entry to and exit from Fast IRQs. + * + * See isr_wrapper.S for details. */ #define _ASMLANGUAGE diff --git a/arch/arc/core/fatal.c b/arch/arc/core/fatal.c index 247d49b1d1d..b72488c5cab 100644 --- a/arch/arc/core/fatal.c +++ b/arch/arc/core/fatal.c @@ -1,5 +1,3 @@ -/* fatal.c - fatal fault handling */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Fatal fault handling + * * This module implements the routines necessary for handling fatal faults on * ARCv2 CPUs. */ diff --git a/arch/arc/core/fault.c b/arch/arc/core/fault.c index 959337fc6f4..9fed0963a8b 100644 --- a/arch/arc/core/fault.c +++ b/arch/arc/core/fault.c @@ -1,5 +1,3 @@ -/* fault.c - common fault handler for ARCv2 */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Common fault handler for ARCv2 + * * Common fault handler for ARCv2 processors. */ diff --git a/arch/arc/core/fault_s.S b/arch/arc/core/fault_s.S index 50ead5db8fa..7c731a3dec1 100644 --- a/arch/arc/core/fault_s.S +++ b/arch/arc/core/fault_s.S @@ -1,5 +1,3 @@ -/* fault_s.S - fault handlers for ARCv2 */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Fault handlers for ARCv2 + * * Fault handlers for ARCv2 processors. */ diff --git a/arch/arc/core/irq_manage.c b/arch/arc/core/irq_manage.c index 904515cb6f2..2976e66ed1f 100644 --- a/arch/arc/core/irq_manage.c +++ b/arch/arc/core/irq_manage.c @@ -1,5 +1,3 @@ -/* irq_manage.c - ARCv2 interrupt management */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARCv2 interrupt management + * * * Interrupt management: * diff --git a/arch/arc/core/isr_wrapper.S b/arch/arc/core/isr_wrapper.S index 7f9bfabb3f3..5f6e202f727 100644 --- a/arch/arc/core/isr_wrapper.S +++ b/arch/arc/core/isr_wrapper.S @@ -1,5 +1,3 @@ -/* isr_wrapper.S - wrapper around ISRs with logic for context switching */ - /* * Copyright (c) 2014-2015 Wind River Systems, Inc. * @@ -16,11 +14,13 @@ * limitations under the License. */ -/* -DESCRIPTION - -Wrapper installed in vector table for handling dynamic interrupts that accept -a parameter. +/** + * @file + * @brief Wrapper around ISRs with logic for context switching + * + * + * Wrapper installed in vector table for handling dynamic interrupts that accept + * a parameter. */ #define _ASMLANGUAGE diff --git a/arch/arc/core/offsets/offsets.c b/arch/arc/core/offsets/offsets.c index 9e6c354d559..ffa07af2e02 100644 --- a/arch/arc/core/offsets/offsets.c +++ b/arch/arc/core/offsets/offsets.c @@ -1,5 +1,3 @@ -/* offsets.c - ARCv2 nano kernel structure member offset definition file */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARCv2 nano kernel structure member offset definition file + * * This module is responsible for the generation of the absolute symbols whose * value represents the member offsets for various ARCv2 nanokernel * structures. diff --git a/arch/arc/core/prep_c.c b/arch/arc/core/prep_c.c index bd2429bfa1a..aafb600e14f 100644 --- a/arch/arc/core/prep_c.c +++ b/arch/arc/core/prep_c.c @@ -1,5 +1,3 @@ -/* prep_c.c - full C support initialization */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Full C support initialization + * * * Initialization of full C support: zero the .bss, copy the .data if XIP, * call _Cstart(). diff --git a/arch/arc/core/regular_irq.S b/arch/arc/core/regular_irq.S index d53408260af..d814f106c1c 100644 --- a/arch/arc/core/regular_irq.S +++ b/arch/arc/core/regular_irq.S @@ -1,5 +1,3 @@ -/* regular_irq.S - handling of transitions to-and-from regular IRQs (RIRQ) */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,12 +14,14 @@ * limitations under the License. */ -/* -DESCRIPTION -This module implements the code for handling entry to and exit from regular -IRQs. - -See isr_wrapper.S for details. +/** + * @file + * @brief Handling of transitions to-and-from regular IRQs (RIRQ) + * + * This module implements the code for handling entry to and exit from regular + * IRQs. + * + * See isr_wrapper.S for details. */ #define _ASMLANGUAGE diff --git a/arch/arc/core/reset.S b/arch/arc/core/reset.S index 0502eef790b..50acd320e95 100644 --- a/arch/arc/core/reset.S +++ b/arch/arc/core/reset.S @@ -1,5 +1,3 @@ -/* reset.S - reset handler */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,9 +14,11 @@ * limitations under the License. */ -/* -DESCRIPTION -Reset handler that prepares the system for running C code. +/** + * @file + * @brief Reset handler + * + * Reset handler that prepares the system for running C code. */ #define _ASMLANGUAGE diff --git a/arch/arc/core/swap.S b/arch/arc/core/swap.S index 6f77dc2974c..7111de3e747 100644 --- a/arch/arc/core/swap.S +++ b/arch/arc/core/swap.S @@ -1,5 +1,3 @@ -/* swap.S - thread context switching */ - /* * Copyright (c) 2014-2015 Wind River Systems, Inc. * @@ -16,12 +14,14 @@ * limitations under the License. */ -/* -DESCRIPTION -This module implements the routines necessary for thread context switching -on ARCv2 CPUs. - -See isr_wrapper.S for details. +/** + * @file + * @brief Thread context switching + * + * This module implements the routines necessary for thread context switching + * on ARCv2 CPUs. + * + * See isr_wrapper.S for details. */ #define _ASMLANGUAGE diff --git a/arch/arc/core/sys_fatal_error_handler.c b/arch/arc/core/sys_fatal_error_handler.c index ecba0252df0..8903ffb29eb 100644 --- a/arch/arc/core/sys_fatal_error_handler.c +++ b/arch/arc/core/sys_fatal_error_handler.c @@ -1,5 +1,3 @@ -/* fatal_error.c - ARCv2 system fatal error handler */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARCv2 system fatal error handler + * * This module provides the _SysFatalErrorHandler() routine for ARCv2 BSPs. */ diff --git a/arch/arc/core/thread.c b/arch/arc/core/thread.c index 702fc622f0d..56cf3e0f996 100644 --- a/arch/arc/core/thread.c +++ b/arch/arc/core/thread.c @@ -1,5 +1,3 @@ -/* thread.c - new thread creation for ARCv2 */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief New thread creation for ARCv2 + * * Core nanokernel fiber related primitives for the ARCv2 processor * architecture. */ diff --git a/arch/arc/core/thread_entry_wrapper.S b/arch/arc/core/thread_entry_wrapper.S index 9fa8121cecc..79e84eb2d02 100644 --- a/arch/arc/core/thread_entry_wrapper.S +++ b/arch/arc/core/thread_entry_wrapper.S @@ -1,5 +1,3 @@ -/* thread_entry_wrapper.S - wrapper for _thread_entry */ - /* * Copyright (c) 2014-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Wrapper for _thread_entry + * * Wrapper for _thread_entry routine when called from the initial context. */ diff --git a/arch/arc/core/vector_table.c b/arch/arc/core/vector_table.c index 67a03c0c5ba..95f712e2209 100644 --- a/arch/arc/core/vector_table.c +++ b/arch/arc/core/vector_table.c @@ -1,5 +1,3 @@ -/* vector_table.c - populated exception vector table */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Populated exception vector table + * * Vector table with exceptions filled in. The reset vector is the system entry * point, ie. the first instruction executed. * diff --git a/arch/arc/include/nano_private.h b/arch/arc/include/nano_private.h index da3ccea6579..555b72fa5a4 100644 --- a/arch/arc/include/nano_private.h +++ b/arch/arc/include/nano_private.h @@ -1,5 +1,3 @@ -/* nano_private.h - private nanokernel definitions */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Private nanokernel definitions + * * This file contains private nanokernel structures definitions and various * other definitions for the ARCv2 processor architecture. * diff --git a/arch/arc/include/v2/cache.h b/arch/arc/include/v2/cache.h index 0f326750be4..c8ac5e73de4 100644 --- a/arch/arc/include/v2/cache.h +++ b/arch/arc/include/v2/cache.h @@ -1,5 +1,3 @@ -/* cache.h - cache helper functions (ARC) */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Cache helper functions (ARC) + * * This file contains private nanokernel structures definitions and various * other definitions for the ARCv2 processor architecture. */ diff --git a/arch/arc/include/v2/irq.h b/arch/arc/include/v2/irq.h index 83bc2af0261..d5355c48633 100644 --- a/arch/arc/include/v2/irq.h +++ b/arch/arc/include/v2/irq.h @@ -1,5 +1,3 @@ -/* irq.h - interrupt helper functions (ARC) */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Interrupt helper functions (ARC) + * * This file contains private nanokernel structures definitions and various * other definitions for the ARCv2 processor architecture. */ diff --git a/arch/arc/include/vector_table.h b/arch/arc/include/vector_table.h index 9b4c4f96f13..cb50448d156 100644 --- a/arch/arc/include/vector_table.h +++ b/arch/arc/include/vector_table.h @@ -1,5 +1,3 @@ -/* vector_table.h - definitions for the exception vector table */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Definitions for the exception vector table + * * * Definitions for the boot vector table. * diff --git a/arch/arc/platforms/generic_arc/board.h b/arch/arc/platforms/generic_arc/board.h index fa531437be3..76120449ef9 100644 --- a/arch/arc/platforms/generic_arc/board.h +++ b/arch/arc/platforms/generic_arc/board.h @@ -1,5 +1,3 @@ -/* board.h - board configuration macros for the generic arc BSP */ - /* * Copyright (c) 2014-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Board configuration macros for the generic arc BSP + * * This header file is used to specify and describe board-level aspects for the * generic arc BSP. */ diff --git a/arch/arc/platforms/generic_arc/irq_vector_table.c b/arch/arc/platforms/generic_arc/irq_vector_table.c index 3f03b1f880e..4eb014e6d46 100644 --- a/arch/arc/platforms/generic_arc/irq_vector_table.c +++ b/arch/arc/platforms/generic_arc/irq_vector_table.c @@ -1,5 +1,3 @@ -/* irq_vector_table.c - IRQ part of vector table for generic arc BSP */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief IRQ part of vector table for generic arc BSP + * * This file contains the IRQ part of the vector table. It is meant to be used * for one of two cases: * diff --git a/arch/arc/platforms/generic_arc/linker.cmd b/arch/arc/platforms/generic_arc/linker.cmd index 4d49bb59bb8..2307d4cb83a 100644 --- a/arch/arc/platforms/generic_arc/linker.cmd +++ b/arch/arc/platforms/generic_arc/linker.cmd @@ -1,5 +1,3 @@ -/* linker.cmd - Linker command/script file */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,10 +14,12 @@ * limitations under the License. */ -/* -DESCRIPTION -This is the linker script for both standard images and XIP images. -*/ +/** + * @file + * @brief Linker command/script file + * + * This is the linker script for both standard images and XIP images. + */ /* Flash base address and size */ #define FLASH_START 0x40034000 /* Flash bank 1 */ diff --git a/arch/arc/platforms/generic_arc/sw_isr_table.c b/arch/arc/platforms/generic_arc/sw_isr_table.c index 1da8467a726..c644f620059 100644 --- a/arch/arc/platforms/generic_arc/sw_isr_table.c +++ b/arch/arc/platforms/generic_arc/sw_isr_table.c @@ -1,5 +1,3 @@ -/* sw_isr_table.c - Software ISR table for generic arc BSP */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Software ISR table for generic arc BSP + * * This contains the ISR table meant to be used for ISRs that take a parameter. * It is also used when ISRs are to be connected at runtime, and in this case * provides a table that is filled with _SpuriousIRQ bindings. diff --git a/arch/arc/platforms/generic_arc/system.c b/arch/arc/platforms/generic_arc/system.c index 21f0c41e856..0d916661980 100644 --- a/arch/arc/platforms/generic_arc/system.c +++ b/arch/arc/platforms/generic_arc/system.c @@ -1,5 +1,3 @@ -/* system.c - system/hardware module for generic arc BSP */ - /* * Copyright (c) 2014-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief System/hardware module for generic arc BSP + * * This module provides routines to initialize and support board-level hardware * for the generic arc platform. */ diff --git a/arch/arm/core/atomic.S b/arch/arm/core/atomic.S index 78be40c18bb..64b69cf57e2 100644 --- a/arch/arm/core/atomic.S +++ b/arch/arm/core/atomic.S @@ -1,5 +1,3 @@ -/* armAtomic.S - ARM atomic operations library */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,11 +14,13 @@ * limitations under the License. */ -/* -DESCRIPTION -This library provides routines to perform a number of atomic operations -on a memory location: add, subtract, increment, decrement, bitwise OR, -bitwise NOR, bitwise AND, bitwise NAND, set, clear and compare-and-swap. +/** + * @file + * @brief ARM atomic operations library + * + * This library provides routines to perform a number of atomic operations + * on a memory location: add, subtract, increment, decrement, bitwise OR, + * bitwise NOR, bitwise AND, bitwise NAND, set, clear and compare-and-swap. */ #define _ASMLANGUAGE diff --git a/arch/arm/core/cortex_m/nmi.c b/arch/arm/core/cortex_m/nmi.c index 6e7cb1eb7d1..76eb13b9161 100644 --- a/arch/arm/core/cortex_m/nmi.c +++ b/arch/arm/core/cortex_m/nmi.c @@ -1,5 +1,3 @@ -/* nmi.c - NMI handler infrastructure */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief NMI handler infrastructure + * * Provides a boot time handler that simply hangs in a sleep loop, and a run * time handler that resets the CPU. Also provides a mechanism for hooking a * custom run time handler. diff --git a/arch/arm/core/cortex_m/prep_c.c b/arch/arm/core/cortex_m/prep_c.c index 8ab5d934a1e..252e5ab39ee 100644 --- a/arch/arm/core/cortex_m/prep_c.c +++ b/arch/arm/core/cortex_m/prep_c.c @@ -1,5 +1,3 @@ -/* prep_c.c - full C support initialization */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Full C support initialization + * * * Initialization of full C support: zero the .bss, copy the .data if XIP, * call _Cstart(). diff --git a/arch/arm/core/cortex_m/reset.S b/arch/arm/core/cortex_m/reset.S index 41328744305..6447e23ba02 100644 --- a/arch/arm/core/cortex_m/reset.S +++ b/arch/arm/core/cortex_m/reset.S @@ -1,5 +1,3 @@ -/* reset_s.S - reset handler */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,9 +14,11 @@ * limitations under the License. */ -/* -DESCRIPTION -Reset handler that prepares the system for running C code. +/** + * @file + * @brief Reset handler + * + * Reset handler that prepares the system for running C code. */ #define _ASMLANGUAGE diff --git a/arch/arm/core/cortex_m/scb.c b/arch/arm/core/cortex_m/scb.c index a0190d3e2ae..4f209c06fb7 100644 --- a/arch/arm/core/cortex_m/scb.c +++ b/arch/arm/core/cortex_m/scb.c @@ -1,5 +1,3 @@ -/* scb.h - ARM CORTEX-M3 System Control Block interface */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM CORTEX-M3 System Control Block interface + * * * Most of the SCB interface consists of simple bit-flipping methods, and is * implemented as inline functions in scb.h. This module thus contains only data diff --git a/arch/arm/core/cortex_m/scs.c b/arch/arm/core/cortex_m/scs.c index 77cd8458c83..e40cafba6ba 100644 --- a/arch/arm/core/cortex_m/scs.c +++ b/arch/arm/core/cortex_m/scs.c @@ -1,5 +1,3 @@ -/* scs.c - ARM CORTEX-M Series System Control Space */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM CORTEX-M Series System Control Space + * * Most of the SCS interface consists of simple bit-flipping methods, and is * implemented as inline functions in scs.h. This module thus contains only data * definitions and more complex routines, if needed. diff --git a/arch/arm/core/cortex_m/sw_isr_table.S b/arch/arm/core/cortex_m/sw_isr_table.S index 32aae681e87..fe7edc14e4c 100644 --- a/arch/arm/core/cortex_m/sw_isr_table.S +++ b/arch/arm/core/cortex_m/sw_isr_table.S @@ -1,5 +1,3 @@ -/* ISR table for static ISR declarations for ARM */ - /* * Copyright (c) 2015 Wind River Systems, Inc. * @@ -16,9 +14,11 @@ * limitations under the License. */ -/* -DESCRIPTION -Software ISR table for ARM +/** + * @file + * @brief ISR table for static ISR declarations for ARM + * + * Software ISR table for ARM */ #define _ASMLANGUAGE diff --git a/arch/arm/core/cortex_m/vector_table.S b/arch/arm/core/cortex_m/vector_table.S index 571bace024a..532bf978a71 100644 --- a/arch/arm/core/cortex_m/vector_table.S +++ b/arch/arm/core/cortex_m/vector_table.S @@ -1,5 +1,3 @@ -/* vector_table.S - populated vector table in ROM */ - /* * Copyright (c) 2013-2015 Wind River Systems, Inc. * @@ -16,14 +14,16 @@ * limitations under the License. */ -/* -DESCRIPTION -Vector table in ROM for starting system. The reset vector is the system entry -point, ie. the first instruction executed. - -The table is populated with all the system exception handlers. The NMI vector -must be populated with a valid handler since it can happen at any time. The -rest should not be triggered until the kernel is ready to handle them. +/** + * @file + * @brief Populated vector table in ROM + * + * Vector table in ROM for starting system. The reset vector is the system entry + * point, ie. the first instruction executed. + * + * The table is populated with all the system exception handlers. The NMI vector + * must be populated with a valid handler since it can happen at any time. The + * rest should not be triggered until the kernel is ready to handle them. */ #define _ASMLANGUAGE diff --git a/arch/arm/core/cortex_m/vector_table.h b/arch/arm/core/cortex_m/vector_table.h index 6cc313c3ce9..f2af60a2a95 100644 --- a/arch/arm/core/cortex_m/vector_table.h +++ b/arch/arm/core/cortex_m/vector_table.h @@ -1,5 +1,3 @@ -/* vector_table.h - definitions for the boot vector table */ - /* * Copyright (c) 2013-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Definitions for the boot vector table + * * * Definitions for the boot vector table. * diff --git a/arch/arm/core/cpu_idle.S b/arch/arm/core/cpu_idle.S index 6f4a39440cc..0c230a0ca75 100644 --- a/arch/arm/core/cpu_idle.S +++ b/arch/arm/core/cpu_idle.S @@ -1,5 +1,3 @@ -/* cpu_idle.S - ARM CORTEX-M3 power management */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* -DESCRIPTION +/** + * @file + * @brief ARM CORTEX-M3 power management + * */ #define _ASMLANGUAGE diff --git a/arch/arm/core/exc_exit.S b/arch/arm/core/exc_exit.S index 23fef71b85f..29d5cf5a8c8 100644 --- a/arch/arm/core/exc_exit.S +++ b/arch/arm/core/exc_exit.S @@ -1,5 +1,3 @@ -/* exc_exit.S - ARM CORTEX-M3 exception/interrupt exit API */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,12 +14,14 @@ * limitations under the License. */ -/* -DESCRIPTION - -Provides functions for performing kernel handling when exiting exceptions or -interrupts that are installed directly in the vector table (i.e. that are not -wrapped around by _isr_wrapper()). +/** + * @file + * @brief ARM CORTEX-M3 exception/interrupt exit API + * + * + * Provides functions for performing kernel handling when exiting exceptions or + * interrupts that are installed directly in the vector table (i.e. that are not + * wrapped around by _isr_wrapper()). */ #define _ASMLANGUAGE diff --git a/arch/arm/core/fatal.c b/arch/arm/core/fatal.c index b328f00aff2..a049c91cece 100644 --- a/arch/arm/core/fatal.c +++ b/arch/arm/core/fatal.c @@ -1,5 +1,3 @@ -/* fatal.c - nanokernel fatal error handler for ARM Cortex-M */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Nanokernel fatal error handler for ARM Cortex-M + * * This module provides the _NanoFatalErrorHandler() routine for ARM Cortex-M. */ diff --git a/arch/arm/core/fault.c b/arch/arm/core/fault.c index f7ffafd2adf..022e5ce8ec0 100644 --- a/arch/arm/core/fault.c +++ b/arch/arm/core/fault.c @@ -1,5 +1,3 @@ -/* fault.c - common fault handler for ARM Cortex-M */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Common fault handler for ARM Cortex-M + * * Common fault handler for ARM Cortex-M processors. */ diff --git a/arch/arm/core/fault_s.S b/arch/arm/core/fault_s.S index 54a4080e245..306bb18f32d 100644 --- a/arch/arm/core/fault_s.S +++ b/arch/arm/core/fault_s.S @@ -1,5 +1,3 @@ -/* fault_s.S - fault handlers for ARM Cortex-M */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,9 +14,11 @@ * limitations under the License. */ -/* -DESCRIPTION -Fault handlers for ARM Cortex-M processors. +/** + * @file + * @brief Fault handlers for ARM Cortex-M + * + * Fault handlers for ARM Cortex-M processors. */ #define _ASMLANGUAGE diff --git a/arch/arm/core/fiber_abort.c b/arch/arm/core/fiber_abort.c index d86855a9ead..705e572dabe 100644 --- a/arch/arm/core/fiber_abort.c +++ b/arch/arm/core/fiber_abort.c @@ -1,5 +1,3 @@ -/* fiber_abort.c - ARM Cortex-M fiber_abort() routine */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM Cortex-M fiber_abort() routine + * * The ARM Cortex-M architecture provides its own fiber_abort() to deal with * different CPU modes (handler vs thread) when a fiber aborts. When its entry * point returns or when it aborts itself, the CPU is in thread mode and must diff --git a/arch/arm/core/gdb_stub.S b/arch/arm/core/gdb_stub.S index 665f07050fc..c957681f885 100644 --- a/arch/arm/core/gdb_stub.S +++ b/arch/arm/core/gdb_stub.S @@ -1,5 +1,3 @@ -/* gdb_stub.S - extra work performed upon exception entry/exit for GDB */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,15 +14,17 @@ * limitations under the License. */ -/* -DESCRIPTION - -Prep work done when entering exceptions consists of saving the callee-saved -registers before they get used by exception handlers, and recording the fact -that we are running in an exception. - -Upon exception exit, it must be recorded that the task is not in an exception -anymore. +/** + * @file + * @brief Extra work performed upon exception entry/exit for GDB + * + * + * Prep work done when entering exceptions consists of saving the callee-saved + * registers before they get used by exception handlers, and recording the fact + * that we are running in an exception. + * + * Upon exception exit, it must be recorded that the task is not in an exception + * anymore. */ #define _ASMLANGUAGE diff --git a/arch/arm/core/gdb_stub_irq_vector_table.c b/arch/arm/core/gdb_stub_irq_vector_table.c index 81b14900b3c..a58058b6430 100644 --- a/arch/arm/core/gdb_stub_irq_vector_table.c +++ b/arch/arm/core/gdb_stub_irq_vector_table.c @@ -1,5 +1,3 @@ -/* gdb_stub_irq_vector_table.c - stubs for IRQ part of vector table */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Stubs for IRQ part of vector table + * * When GDB is enabled, the static IRQ vector table needs to install the * _irq_vector_table_entry_with_gdb_stub stub to do some work before calling the * user-installed ISRs. diff --git a/arch/arm/core/irq_init.c b/arch/arm/core/irq_init.c index 5f70c03beb1..0b5a1530769 100644 --- a/arch/arm/core/irq_init.c +++ b/arch/arm/core/irq_init.c @@ -1,5 +1,3 @@ -/* irq_init.c - ARM Cortex-M interrupt initialization */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM Cortex-M interrupt initialization + * * The ARM Cortex-M architecture provides its own fiber_abort() to deal with * different CPU modes (handler vs thread) when a fiber aborts. When its entry * point returns or when it aborts itself, the CPU is in thread mode and must diff --git a/arch/arm/core/irq_manage.c b/arch/arm/core/irq_manage.c index 97b8f2943c9..cb1af4f9f51 100644 --- a/arch/arm/core/irq_manage.c +++ b/arch/arm/core/irq_manage.c @@ -1,5 +1,3 @@ -/* irq_manage.c - ARM CORTEX-M3 interrupt management */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM CORTEX-M3 interrupt management + * * * Interrupt management: enabling/disabling and dynamic ISR * connecting/replacing. SW_ISR_TABLE_DYNAMIC has to be enabled for diff --git a/arch/arm/core/isr_wrapper.S b/arch/arm/core/isr_wrapper.S index fd9da9c24dc..d0af796241b 100644 --- a/arch/arm/core/isr_wrapper.S +++ b/arch/arm/core/isr_wrapper.S @@ -1,5 +1,3 @@ -/* isr_wrapper.S - ARM CORTEX-M3 wrapper for ISRs with parameter */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,11 +14,12 @@ * limitations under the License. */ -/* -DESCRIPTION - -Wrapper installed in vector table for handling dynamic interrupts that accept -a parameter. +/** + * @file + * @brief ARM CORTEX-M3 wrapper for ISRs with parameter + * + * Wrapper installed in vector table for handling dynamic interrupts that accept + * a parameter. */ #define _ASMLANGUAGE diff --git a/arch/arm/core/offsets/offsets.c b/arch/arm/core/offsets/offsets.c index 292c8ae0cae..334fa6d33e8 100644 --- a/arch/arm/core/offsets/offsets.c +++ b/arch/arm/core/offsets/offsets.c @@ -1,5 +1,3 @@ -/* offsets.c - ARM nano kernel structure member offset definition file */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM nano kernel structure member offset definition file + * * This module is responsible for the generation of the absolute symbols whose * value represents the member offsets for various ARM nanokernel * structures. diff --git a/arch/arm/core/swap.S b/arch/arm/core/swap.S index 6c9d535a151..52952bba6ff 100644 --- a/arch/arm/core/swap.S +++ b/arch/arm/core/swap.S @@ -1,5 +1,3 @@ -/* swap.S - thread context switching for ARM Cortex-M */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,10 +14,12 @@ * limitations under the License. */ -/* -DESCRIPTION -This module implements the routines necessary for thread context switching -on ARM Cortex-M3/M4 CPUs. +/** + * @file + * @brief Thread context switching for ARM Cortex-M + * + * This module implements the routines necessary for thread context switching + * on ARM Cortex-M3/M4 CPUs. */ #define _ASMLANGUAGE diff --git a/arch/arm/core/sys_fatal_error_handler.c b/arch/arm/core/sys_fatal_error_handler.c index 9a908275c15..c4c2e0665be 100644 --- a/arch/arm/core/sys_fatal_error_handler.c +++ b/arch/arm/core/sys_fatal_error_handler.c @@ -1,5 +1,3 @@ -/* sysFatalErrorHandler - ARM Cortex-M system fatal error handler */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM Cortex-M system fatal error handler + * * This module provides the _SysFatalErrorHandler() routine for Cortex-M * platforms. */ diff --git a/arch/arm/core/task_abort.c b/arch/arm/core/task_abort.c index 03ae8588178..f23519493bc 100644 --- a/arch/arm/core/task_abort.c +++ b/arch/arm/core/task_abort.c @@ -1,5 +1,3 @@ -/* task_abort.c - ARM Cortex-M _TaskAbort() routine */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM Cortex-M _TaskAbort() routine + * * The ARM Cortex-M architecture provides its own _TaskAbort() to deal with * different CPU modes (handler vs thread) when a task aborts. When its entry * point returns or when it aborts itself, the CPU is in thread mode and must diff --git a/arch/arm/core/thread.c b/arch/arm/core/thread.c index 251ab316947..ef3ad3c53ad 100644 --- a/arch/arm/core/thread.c +++ b/arch/arm/core/thread.c @@ -1,5 +1,3 @@ -/* thread.c - new thread creation for ARM Cortex-M */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief New thread creation for ARM Cortex-M + * * Core nanokernel fiber related primitives for the ARM Cortex-M processor * architecture. */ diff --git a/arch/arm/include/cortex_m/exc.h b/arch/arm/include/cortex_m/exc.h index ecc66ccf5c5..e6f5c29ca62 100644 --- a/arch/arm/include/cortex_m/exc.h +++ b/arch/arm/include/cortex_m/exc.h @@ -1,5 +1,3 @@ -/* exc.h - exception/interrupt context helpers for Cortex-M CPUs */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Exception/interrupt context helpers for Cortex-M CPUs + * * Exception/interrupt context helpers. */ diff --git a/arch/arm/include/cortex_m/stack.h b/arch/arm/include/cortex_m/stack.h index a8b22ad4461..cd1d29e5f6e 100644 --- a/arch/arm/include/cortex_m/stack.h +++ b/arch/arm/include/cortex_m/stack.h @@ -1,5 +1,3 @@ -/* stack.h - stack helpers for Cortex-M CPUs */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Stack helpers for Cortex-M CPUs + * * Stack helper functions. */ diff --git a/arch/arm/include/kernel_event_logger_arch.h b/arch/arm/include/kernel_event_logger_arch.h index de43e59846a..3c08b9473d4 100644 --- a/arch/arm/include/kernel_event_logger_arch.h +++ b/arch/arm/include/kernel_event_logger_arch.h @@ -14,7 +14,7 @@ * limitations under the License. */ -/* +/** * @file * @brief Kernel event logger support for ARM */ diff --git a/arch/arm/include/nano_private.h b/arch/arm/include/nano_private.h index 19cf76908aa..79ae110887e 100644 --- a/arch/arm/include/nano_private.h +++ b/arch/arm/include/nano_private.h @@ -1,5 +1,3 @@ -/* nano_private.h - private nanokernel definitions (ARM) */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Private nanokernel definitions (ARM) + * * This file contains private nanokernel structures definitions and various * other definitions for the ARM Cortex-M3 processor architecture. * diff --git a/arch/arm/include/start_task_arch.h b/arch/arm/include/start_task_arch.h index 8d80ec084c3..93e819fa5cf 100644 --- a/arch/arm/include/start_task_arch.h +++ b/arch/arm/include/start_task_arch.h @@ -1,5 +1,3 @@ -/* start_task.h - ARM nanokernel declarations to start a task */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM nanokernel declarations to start a task + * * ARM-specific parts of start_task(). * * Currently empty, only here for abstraction. diff --git a/arch/arm/platforms/fsl_frdm_k64f/board.h b/arch/arm/platforms/fsl_frdm_k64f/board.h index 2f8e728ffaa..05786bba34b 100644 --- a/arch/arm/platforms/fsl_frdm_k64f/board.h +++ b/arch/arm/platforms/fsl_frdm_k64f/board.h @@ -1,5 +1,3 @@ -/* board.h - board configuration macros for the fsl_frdm_k64f platform */ - /* * Copyright (c) 2014-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Board configuration macros for the fsl_frdm_k64f platform + * * This header file is used to specify and describe board-level aspects for the * 'fsl_frdm_k64f' platform. */ diff --git a/arch/arm/platforms/fsl_frdm_k64f/irq_vector_table.c b/arch/arm/platforms/fsl_frdm_k64f/irq_vector_table.c index 3284191a3ca..8719b39ded8 100644 --- a/arch/arm/platforms/fsl_frdm_k64f/irq_vector_table.c +++ b/arch/arm/platforms/fsl_frdm_k64f/irq_vector_table.c @@ -1,5 +1,3 @@ -/* irq_vector_table.c - IRQ part of vector table */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief IRQ part of vector table + * * This file contains the IRQ part of the vector table. It is meant to be used * for one of two cases: * diff --git a/arch/arm/platforms/fsl_frdm_k64f/linker.cmd b/arch/arm/platforms/fsl_frdm_k64f/linker.cmd index 52da3895e41..6e8fae68c77 100644 --- a/arch/arm/platforms/fsl_frdm_k64f/linker.cmd +++ b/arch/arm/platforms/fsl_frdm_k64f/linker.cmd @@ -1,5 +1,3 @@ -/* linker.cmd - Linker command/script file */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,9 +14,11 @@ * limitations under the License. */ -/* -DESCRIPTION -This is the linker script for both standard images and XIP images. +/** + * @file + * @brief Linker command/script file + * + * This is the linker script for both standard images and XIP images. */ /* diff --git a/arch/arm/platforms/fsl_frdm_k64f/nmi_on_reset.S b/arch/arm/platforms/fsl_frdm_k64f/nmi_on_reset.S index 5479461ebb1..3e329a87603 100644 --- a/arch/arm/platforms/fsl_frdm_k64f/nmi_on_reset.S +++ b/arch/arm/platforms/fsl_frdm_k64f/nmi_on_reset.S @@ -1,5 +1,3 @@ -/* nmi_on_reset.S - default basic NMI handler before the kernel is up */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,13 +14,15 @@ * limitations under the License. */ -/* -DESCRIPTION -Provide a default handler for NMI before the system is up. The default action -is to hard hang, sleeping. - -This might be preferable than rebooting to help debugging, or because -rebooting might trigger the exact same problem over and over. +/** + * @file + * @brief Default basic NMI handler before the kernel is up + * + * Provide a default handler for NMI before the system is up. The default action + * is to hard hang, sleeping. + * + * This might be preferable than rebooting to help debugging, or because + * rebooting might trigger the exact same problem over and over. */ #define _ASMLANGUAGE diff --git a/arch/arm/platforms/fsl_frdm_k64f/system.c b/arch/arm/platforms/fsl_frdm_k64f/system.c index 612ada967cf..d974d8924d9 100644 --- a/arch/arm/platforms/fsl_frdm_k64f/system.c +++ b/arch/arm/platforms/fsl_frdm_k64f/system.c @@ -1,5 +1,3 @@ -/* system.c - system/hardware module for fsl_frdm_k64f platform */ - /* * Copyright (c) 2014-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief System/hardware module for fsl_frdm_k64f platform + * * This module provides routines to initialize and support board-level * hardware for the fsl_frdm_k64f platform. */ diff --git a/arch/arm/platforms/fsl_frdm_k64f/wdog.S b/arch/arm/platforms/fsl_frdm_k64f/wdog.S index 18b3a44ac99..d950526ee84 100644 --- a/arch/arm/platforms/fsl_frdm_k64f/wdog.S +++ b/arch/arm/platforms/fsl_frdm_k64f/wdog.S @@ -1,5 +1,3 @@ -/* wdog.S - watchdog initialization for fsl_frdm_k64f platform */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,9 +14,11 @@ * limitations under the License. */ -/* -DESCRIPTION -This module initializes the watchdog for the fsl_frdm_k64f platform. +/** + * @file + * @brief Watchdog initialization for fsl_frdm_k64f platform + * + * This module initializes the watchdog for the fsl_frdm_k64f platform. */ #define _ASMLANGUAGE diff --git a/arch/arm/platforms/qemu_arm/board.h b/arch/arm/platforms/qemu_arm/board.h index 33e44f15be2..c8b4bc1e66c 100644 --- a/arch/arm/platforms/qemu_arm/board.h +++ b/arch/arm/platforms/qemu_arm/board.h @@ -1,5 +1,3 @@ -/* board.h - board configuration macros for the QEMU for arm platform */ - /* * Copyright (c) 2013-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Board configuration macros for the QEMU for arm platform + * * This header file is used to specify and describe board-level aspects for * the 'QEMU' platform. */ diff --git a/arch/arm/platforms/qemu_arm/irq_vector_table.c b/arch/arm/platforms/qemu_arm/irq_vector_table.c index 3284191a3ca..8719b39ded8 100644 --- a/arch/arm/platforms/qemu_arm/irq_vector_table.c +++ b/arch/arm/platforms/qemu_arm/irq_vector_table.c @@ -1,5 +1,3 @@ -/* irq_vector_table.c - IRQ part of vector table */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief IRQ part of vector table + * * This file contains the IRQ part of the vector table. It is meant to be used * for one of two cases: * diff --git a/arch/arm/platforms/qemu_arm/nmi_on_reset.S b/arch/arm/platforms/qemu_arm/nmi_on_reset.S index 5479461ebb1..3e329a87603 100644 --- a/arch/arm/platforms/qemu_arm/nmi_on_reset.S +++ b/arch/arm/platforms/qemu_arm/nmi_on_reset.S @@ -1,5 +1,3 @@ -/* nmi_on_reset.S - default basic NMI handler before the kernel is up */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,13 +14,15 @@ * limitations under the License. */ -/* -DESCRIPTION -Provide a default handler for NMI before the system is up. The default action -is to hard hang, sleeping. - -This might be preferable than rebooting to help debugging, or because -rebooting might trigger the exact same problem over and over. +/** + * @file + * @brief Default basic NMI handler before the kernel is up + * + * Provide a default handler for NMI before the system is up. The default action + * is to hard hang, sleeping. + * + * This might be preferable than rebooting to help debugging, or because + * rebooting might trigger the exact same problem over and over. */ #define _ASMLANGUAGE diff --git a/arch/arm/platforms/qemu_arm/scp.c b/arch/arm/platforms/qemu_arm/scp.c index 6c001e91d8e..79985d34f3a 100644 --- a/arch/arm/platforms/qemu_arm/scp.c +++ b/arch/arm/platforms/qemu_arm/scp.c @@ -1,5 +1,3 @@ -/* scp.c - TI LM3S6965 System Control Peripherals interface */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief TI LM3S6965 System Control Peripherals interface + * * * Library for controlling target-specific devices present in the 0x400fe000 * peripherals memory region. diff --git a/arch/arm/platforms/qemu_arm/scp.h b/arch/arm/platforms/qemu_arm/scp.h index 5e677d16278..0fa37271eda 100644 --- a/arch/arm/platforms/qemu_arm/scp.h +++ b/arch/arm/platforms/qemu_arm/scp.h @@ -1,5 +1,3 @@ -/* scp.h - TI LM3S6965 System Control Peripherals interface */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief TI LM3S6965 System Control Peripherals interface + * * This module defines the System Control Peripheral Registers for TI LM3S6965 * processor. The registers defined are in region 0x400fe000. * diff --git a/arch/arm/platforms/qemu_arm/system.c b/arch/arm/platforms/qemu_arm/system.c index afbf09f86ba..efe8a271120 100644 --- a/arch/arm/platforms/qemu_arm/system.c +++ b/arch/arm/platforms/qemu_arm/system.c @@ -1,5 +1,3 @@ -/* system.c - system/hardware module for ti_lm3s6965 platform */ - /* * Copyright (c) 2013-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief System/hardware module for ti_lm3s6965 platform + * * This module provides routines to initialize and support board-level hardware * for the ti_lm3s6965 platform. */ diff --git a/arch/x86/core/atomic.c b/arch/x86/core/atomic.c index 9ca2f2de9c2..3a76ffc1f09 100644 --- a/arch/x86/core/atomic.c +++ b/arch/x86/core/atomic.c @@ -15,9 +15,10 @@ * limitations under the License. */ -/* +/** * @file Atomic ops for x86 - * DESCRIPTION This module provides the atomic operators for IA-32 + * + * This module provides the atomic operators for IA-32 * architectures on platforms that support the LOCK prefix instruction. * * The atomic operations are guaranteed to be atomic with respect diff --git a/arch/x86/core/cache.c b/arch/x86/core/cache.c index 35f959c1c5d..f4c868dadb4 100644 --- a/arch/x86/core/cache.c +++ b/arch/x86/core/cache.c @@ -1,5 +1,3 @@ -/* cache.c - cache manipulation */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -15,8 +13,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Cache manipulation + * * This module contains functions for manipulation caches. */ diff --git a/arch/x86/core/cache_s.S b/arch/x86/core/cache_s.S index 30381397cc0..c201ff31556 100644 --- a/arch/x86/core/cache_s.S +++ b/arch/x86/core/cache_s.S @@ -1,5 +1,3 @@ -/* cache_s.S - cache manipulation */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -15,9 +13,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -/* -DESCRIPTION -This module contains functions for manipulating caches. +/** + * @file + * @brief Cache manipulation + * + * This module contains functions for manipulating caches. */ #define _ASMLANGUAGE diff --git a/arch/x86/core/crt0.S b/arch/x86/core/crt0.S index e4353b6c524..5591a68b2ad 100644 --- a/arch/x86/core/crt0.S +++ b/arch/x86/core/crt0.S @@ -1,5 +1,3 @@ -/* crt0.S - crt0 module for the IA-32 boards */ - /* * Copyright (c) 2010-2015 Wind River Systems, Inc. * @@ -15,11 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -/* -DESCRIPTION -This module contains the initial code executed by the Zephyr Kernel ELF image -after having been loaded into RAM. -*/ +/** + * @file + * @brief Crt0 module for the IA-32 boards + * + * This module contains the initial code executed by the Zephyr Kernel ELF image + * after having been loaded into RAM. + */ #define _ASMLANGUAGE diff --git a/arch/x86/core/driver_static_irq_stubs.S b/arch/x86/core/driver_static_irq_stubs.S index b92b7ad5177..d354afcd097 100644 --- a/arch/x86/core/driver_static_irq_stubs.S +++ b/arch/x86/core/driver_static_irq_stubs.S @@ -1,5 +1,3 @@ -/* driver_static_irq_stubs.S - interrupt stubs */ - /* * Copyright (c) 2012-2015, Wind River Systems, Inc. * @@ -16,10 +14,12 @@ * limitations under the License. */ -/* -DESCRIPTION -This module contains the static interrupt stubs for the various drivers employed -by x86 platforms. +/** + * @file + * @brief Interrupt stubs + * + * This module contains the static interrupt stubs for the various drivers employed + * by x86 platforms. */ #define _ASMLANGUAGE diff --git a/arch/x86/core/excconnect.c b/arch/x86/core/excconnect.c index 61340692675..305008a4585 100644 --- a/arch/x86/core/excconnect.c +++ b/arch/x86/core/excconnect.c @@ -1,5 +1,3 @@ -/* excconnect.c - exception management support for IA-32 arch */ - /* * Copyright (c) 2010-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Exception management support for IA-32 arch + * * This module provides routines to manage exceptions (synchronous interrupts) * on the IA-32 architecture. * diff --git a/arch/x86/core/fatal.c b/arch/x86/core/fatal.c index eb099f7e42c..c68bea25455 100644 --- a/arch/x86/core/fatal.c +++ b/arch/x86/core/fatal.c @@ -1,5 +1,3 @@ -/* fatal.c - nanokernel fatal error handler */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Nanokernel fatal error handler + * * This module provides the _NanoFatalErrorHandler() routine. */ diff --git a/arch/x86/core/float.c b/arch/x86/core/float.c index b25f745fb3d..2d35b698cb5 100644 --- a/arch/x86/core/float.c +++ b/arch/x86/core/float.c @@ -1,5 +1,3 @@ -/* float.c - floating point resource sharing routines */ - /* * Copyright (c) 2010-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Floating point resource sharing routines + * * This module allows multiple tasks and fibers to safely share the system's * floating point resources, by allowing the system to save FPU state * information in a task or fiber's stack region when a pre-emptive context diff --git a/arch/x86/core/gdt.c b/arch/x86/core/gdt.c index 4dc89fa3575..e0e536e0063 100644 --- a/arch/x86/core/gdt.c +++ b/arch/x86/core/gdt.c @@ -1,5 +1,3 @@ -/* gdt.c - Global Descriptor Table support */ - /* * Copyright (c) 2011-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Global Descriptor Table support + * * This module contains routines for updating the global descriptor table (GDT) * for the IA-32 architecture. */ diff --git a/arch/x86/core/i386_sysV_abi/excstub.S b/arch/x86/core/i386_sysV_abi/excstub.S index c34012cc5ca..64c5b003bfc 100644 --- a/arch/x86/core/i386_sysV_abi/excstub.S +++ b/arch/x86/core/i386_sysV_abi/excstub.S @@ -1,5 +1,3 @@ -/* excstub.S - exception management support for IA-32 architecture */ - /* * Copyright (c) 2011-2015 Wind River Systems, Inc. * @@ -16,12 +14,14 @@ * limitations under the License. */ -/* -DESCRIPTION -This module implements assembly routines to manage exceptions (synchronous -interrupts) on the Intel IA-32 architecture. More specifically, -exceptions are implemented in this module. The stubs are invoked when entering -and exiting a C exception handler. +/** + * @file + * @brief Exception management support for IA-32 architecture + * + * This module implements assembly routines to manage exceptions (synchronous + * interrupts) on the Intel IA-32 architecture. More specifically, + * exceptions are implemented in this module. The stubs are invoked when entering + * and exiting a C exception handler. */ #define _ASMLANGUAGE diff --git a/arch/x86/core/i386_sysV_abi/intstub.S b/arch/x86/core/i386_sysV_abi/intstub.S index dd80e058862..10bab505fe3 100644 --- a/arch/x86/core/i386_sysV_abi/intstub.S +++ b/arch/x86/core/i386_sysV_abi/intstub.S @@ -1,5 +1,3 @@ -/* intstub.S - interrupt management support for IA-32 architecture */ - /* * Copyright (c) 2010-2014 Wind River Systems, Inc. * @@ -16,13 +14,15 @@ * limitations under the License. */ -/* -DESCRIPTION -This module implements assembly routines to manage interrupts on -the Intel IA-32 architecture. More specifically, the interrupt (asynchronous -exception) stubs are implemented in this module. The stubs are invoked when -entering and exiting a C interrupt handler. -*/ +/** + * @file + * @brief Interrupt management support for IA-32 architecture + * + * This module implements assembly routines to manage interrupts on + * the Intel IA-32 architecture. More specifically, the interrupt (asynchronous + * exception) stubs are implemented in this module. The stubs are invoked when + * entering and exiting a C interrupt handler. + */ #define _ASMLANGUAGE diff --git a/arch/x86/core/i386_sysV_abi/swap.S b/arch/x86/core/i386_sysV_abi/swap.S index 13ad6cc6a8f..923d7f3daaa 100644 --- a/arch/x86/core/i386_sysV_abi/swap.S +++ b/arch/x86/core/i386_sysV_abi/swap.S @@ -1,5 +1,3 @@ -/* swap.S - nanokernel swapper code for IA-32 */ - /* * Copyright (c) 2010-2015 Wind River Systems, Inc. * @@ -16,15 +14,17 @@ * limitations under the License. */ -/* -DESCRIPTION -This module implements the _Swap() routine for the IA-32 architecture. - -Note that the file include/nanokernel/x86/swapstk.h defines -a representation of the save stack frame generated by _Swap() in order -to generate offsets (in the form of absolute symbols) for consumption by -host tools. Please update swapstk.h if changing the structure of the -save frame on the stack. +/** + * @file + * @brief Nanokernel swapper code for IA-32 + * + * This module implements the _Swap() routine for the IA-32 architecture. + * + * Note that the file include/nanokernel/x86/swapstk.h defines + * a representation of the save stack frame generated by _Swap() in order + * to generate offsets (in the form of absolute symbols) for consumption by + * host tools. Please update swapstk.h if changing the structure of the + * save frame on the stack. */ #define _ASMLANGUAGE diff --git a/arch/x86/core/i386_sysV_abi/thread.c b/arch/x86/core/i386_sysV_abi/thread.c index 73101891739..5337fb93e54 100644 --- a/arch/x86/core/i386_sysV_abi/thread.c +++ b/arch/x86/core/i386_sysV_abi/thread.c @@ -1,5 +1,3 @@ -/* thread.c - nanokernel thread support primitives */ - /* * Copyright (c) 2010-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Nanokernel thread support primitives + * * This module provides core nanokernel fiber related primitives for the IA-32 * processor architecture. */ diff --git a/arch/x86/core/intconnect.c b/arch/x86/core/intconnect.c index 679b6bbc908..ce71fd6b2ff 100644 --- a/arch/x86/core/intconnect.c +++ b/arch/x86/core/intconnect.c @@ -1,5 +1,3 @@ -/* intconnect.c - interrupt management support for IA-32 arch */ - /* * Copyright (c) 2010-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Interrupt management support for IA-32 arch + * * This module provides routines to manage asynchronous interrupts * on the IA-32 architecture. * diff --git a/arch/x86/core/offsets/offsets.c b/arch/x86/core/offsets/offsets.c index 11d5817696a..65d8af1f80c 100644 --- a/arch/x86/core/offsets/offsets.c +++ b/arch/x86/core/offsets/offsets.c @@ -1,5 +1,3 @@ -/* offsets.c - nanokernel structure member offset definition file */ - /* * Copyright (c) 2010-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Nanokernel structure member offset definition file + * * This module is responsible for the generation of the absolute symbols whose * value represents the member offsets for various IA-32 nanokernel structures. * diff --git a/arch/x86/core/strtask.c b/arch/x86/core/strtask.c index 76a13914b4f..dbe4d30b744 100644 --- a/arch/x86/core/strtask.c +++ b/arch/x86/core/strtask.c @@ -1,5 +1,3 @@ -/* strtask.c - Intel nanokernel APIs to start a task */ - /* * Copyright (c) 2010-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Intel nanokernel APIs to start a task + * * Intel-specific parts of start_task(). Only FP functionality currently. */ diff --git a/arch/x86/core/sys_fatal_error_handler.c b/arch/x86/core/sys_fatal_error_handler.c index 1bde145bd10..12cf9d7bdb4 100644 --- a/arch/x86/core/sys_fatal_error_handler.c +++ b/arch/x86/core/sys_fatal_error_handler.c @@ -1,5 +1,3 @@ -/* sysFatalErrorHandler - common system fatal error handler */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Common system fatal error handler + * * This module provides the _SysFatalErrorHandler() routine which is common to * supported platforms. */ diff --git a/arch/x86/include/gdt.h b/arch/x86/include/gdt.h index 4da3215edf8..07f95080048 100644 --- a/arch/x86/include/gdt.h +++ b/arch/x86/include/gdt.h @@ -1,5 +1,3 @@ -/* gdt.h - IA-32 Global Descriptor Table (GDT) definitions */ - /* * Copyright (c) 2011-2012, 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief IA-32 Global Descriptor Table (GDT) definitions + * * This file provides definitions for the Global Descriptor Table (GDT) for the * IA-32 architecture. */ diff --git a/arch/x86/include/idtEnt.h b/arch/x86/include/idtEnt.h index c20f649b097..6d79c68e3ed 100644 --- a/arch/x86/include/idtEnt.h +++ b/arch/x86/include/idtEnt.h @@ -1,5 +1,3 @@ -/* idtEnt.h - IA-32 IDT Entry code */ - /* * Copyright (c) 2012-2014, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief IA-32 IDT Entry code + * * This header file provides code for constructing an IA-32 interrupt * descriptor. */ diff --git a/arch/x86/include/kernel_event_logger_arch.h b/arch/x86/include/kernel_event_logger_arch.h index f1c4b7f696f..b65bb37f541 100644 --- a/arch/x86/include/kernel_event_logger_arch.h +++ b/arch/x86/include/kernel_event_logger_arch.h @@ -14,7 +14,7 @@ * limitations under the License. */ -/* +/** * @file * @brief Kernel event logger support for x86 */ diff --git a/arch/x86/include/nano_private.h b/arch/x86/include/nano_private.h index cb901e9dccb..3947249dff8 100644 --- a/arch/x86/include/nano_private.h +++ b/arch/x86/include/nano_private.h @@ -1,5 +1,3 @@ -/* nano_private.h - private nanokernel definitions (IA-32) */ - /* * Copyright (c) 2010-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Private nanokernel definitions (IA-32) + * * This file contains private nanokernel structures definitions and various * other definitions for the Intel Architecture 32 bit (IA-32) processor * architecture. diff --git a/arch/x86/include/start_task_arch.h b/arch/x86/include/start_task_arch.h index 0a501a3021c..81c814ea202 100644 --- a/arch/x86/include/start_task_arch.h +++ b/arch/x86/include/start_task_arch.h @@ -1,5 +1,3 @@ -/* start_task.h - Intel nanokernel declarations to start a task */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Intel nanokernel declarations to start a task + * * Intel-specific parts of start_task(). Only FP functionality currently. */ diff --git a/arch/x86/include/swapstk.h b/arch/x86/include/swapstk.h index 2ba157c2844..2749d0b64ba 100644 --- a/arch/x86/include/swapstk.h +++ b/arch/x86/include/swapstk.h @@ -1,5 +1,3 @@ -/* swapstk.h - stack frame created by swap (IA-32) */ - /* * Copyright (c) 2011-2012, 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Stack frame created by swap (IA-32) + * * This file details the stack frame generated by _Swap() when it saves a task * or fiber's context. This is specific to the IA-32 processor architecture. * diff --git a/arch/x86/platforms/galileo/board.h b/arch/x86/platforms/galileo/board.h index ede50f6dcc4..d6e99c8e1fc 100644 --- a/arch/x86/platforms/galileo/board.h +++ b/arch/x86/platforms/galileo/board.h @@ -1,5 +1,3 @@ -/* board.h - board configuration macros for the galileo platform */ - /* * Copyright (c) 2013-2015, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Board configuration macros for the galileo platform + * * This header file is used to specify and describe board-level aspects for * the 'galileo' platform. */ diff --git a/arch/x86/platforms/galileo/galileo.c b/arch/x86/platforms/galileo/galileo.c index e1d221d0b99..3fe80e36ca6 100644 --- a/arch/x86/platforms/galileo/galileo.c +++ b/arch/x86/platforms/galileo/galileo.c @@ -1,5 +1,3 @@ -/* galileo.c - system/hardware module for the galileo platform */ - /* * Copyright (c) 2013-2015, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief System/hardware module for the galileo platform + * * This module provides routines to initialize and support board-level hardware * for the galileo platform. * diff --git a/arch/x86/platforms/galileo/linker.cmd b/arch/x86/platforms/galileo/linker.cmd index c1ff1e81709..654bfbe3562 100644 --- a/arch/x86/platforms/galileo/linker.cmd +++ b/arch/x86/platforms/galileo/linker.cmd @@ -1,5 +1,3 @@ -/* linker.cmd - Linker command/script file */ - /* * Copyright (c) 2011-2014, Wind River Systems, Inc. * @@ -16,9 +14,11 @@ * limitations under the License. */ -/* -DESCRIPTION -This is the linker script for both standard images and XIP images. +/** + * @file + * @brief Linker command/script file + * + * This is the linker script for both standard images and XIP images. */ #include diff --git a/arch/x86/platforms/ia32/board.h b/arch/x86/platforms/ia32/board.h index 3210a1344a4..6ca302c5260 100644 --- a/arch/x86/platforms/ia32/board.h +++ b/arch/x86/platforms/ia32/board.h @@ -1,5 +1,3 @@ -/* board.h - board configuration macros for the ia32 platform */ - /* * Copyright (c) 2010-2015, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Board configuration macros for the ia32 platform + * * This header file is used to specify and describe board-level aspects for * the 'ia32' platform. */ diff --git a/arch/x86/platforms/ia32/ia32.c b/arch/x86/platforms/ia32/ia32.c index 0a5dba1c929..e258cac7e4f 100644 --- a/arch/x86/platforms/ia32/ia32.c +++ b/arch/x86/platforms/ia32/ia32.c @@ -1,5 +1,3 @@ -/* ia32.c - system/hardware module for the ia32 platform */ - /* * Copyright (c) 2011-2015, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief System/hardware module for the ia32 platform + * * This module provides routines to initialize and support board-level hardware * for the ia32 platform. */ diff --git a/arch/x86/platforms/ia32/linker.cmd b/arch/x86/platforms/ia32/linker.cmd index c1ff1e81709..654bfbe3562 100644 --- a/arch/x86/platforms/ia32/linker.cmd +++ b/arch/x86/platforms/ia32/linker.cmd @@ -1,5 +1,3 @@ -/* linker.cmd - Linker command/script file */ - /* * Copyright (c) 2011-2014, Wind River Systems, Inc. * @@ -16,9 +14,11 @@ * limitations under the License. */ -/* -DESCRIPTION -This is the linker script for both standard images and XIP images. +/** + * @file + * @brief Linker command/script file + * + * This is the linker script for both standard images and XIP images. */ #include diff --git a/arch/x86/platforms/ia32_pci/board.h b/arch/x86/platforms/ia32_pci/board.h index 8c1a69f7e20..f7aeb15161e 100644 --- a/arch/x86/platforms/ia32_pci/board.h +++ b/arch/x86/platforms/ia32_pci/board.h @@ -1,5 +1,3 @@ -/* board.h - board configuration macros for the ia32_pci platform */ - /* * Copyright (c) 2013-2015, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Board configuration macros for the ia32_pci platform + * * This header file is used to specify and describe board-level aspects for * the 'ia32_pci' platform. */ diff --git a/arch/x86/platforms/ia32_pci/ia32_pci.c b/arch/x86/platforms/ia32_pci/ia32_pci.c index 930df43094c..09770f8f9a8 100644 --- a/arch/x86/platforms/ia32_pci/ia32_pci.c +++ b/arch/x86/platforms/ia32_pci/ia32_pci.c @@ -1,5 +1,3 @@ -/* ia32_pci.c - system/hardware module for the ia32_pci platform */ - /* * Copyright (c) 2013-2015, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief System/hardware module for the ia32_pci platform + * * This module provides routines to initialize and support board-level hardware * for the ia32_pci platform. * diff --git a/arch/x86/platforms/ia32_pci/linker.cmd b/arch/x86/platforms/ia32_pci/linker.cmd index c1ff1e81709..654bfbe3562 100644 --- a/arch/x86/platforms/ia32_pci/linker.cmd +++ b/arch/x86/platforms/ia32_pci/linker.cmd @@ -1,5 +1,3 @@ -/* linker.cmd - Linker command/script file */ - /* * Copyright (c) 2011-2014, Wind River Systems, Inc. * @@ -16,9 +14,11 @@ * limitations under the License. */ -/* -DESCRIPTION -This is the linker script for both standard images and XIP images. +/** + * @file + * @brief Linker command/script file + * + * This is the linker script for both standard images and XIP images. */ #include diff --git a/arch/x86/platforms/qemu_x86/board.h b/arch/x86/platforms/qemu_x86/board.h index b3d2e4d91e2..52c90e2ead3 100644 --- a/arch/x86/platforms/qemu_x86/board.h +++ b/arch/x86/platforms/qemu_x86/board.h @@ -1,5 +1,3 @@ -/* board.h - board configuration macros for the QEMU platform */ - /* * Copyright (c) 2010-2015, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Board configuration macros for the QEMU platform + * * This header file is used to specify and describe board-level aspects for * the 'QEMU' platform. */ diff --git a/arch/x86/platforms/qemu_x86/linker.cmd b/arch/x86/platforms/qemu_x86/linker.cmd index c1ff1e81709..654bfbe3562 100644 --- a/arch/x86/platforms/qemu_x86/linker.cmd +++ b/arch/x86/platforms/qemu_x86/linker.cmd @@ -1,5 +1,3 @@ -/* linker.cmd - Linker command/script file */ - /* * Copyright (c) 2011-2014, Wind River Systems, Inc. * @@ -16,9 +14,11 @@ * limitations under the License. */ -/* -DESCRIPTION -This is the linker script for both standard images and XIP images. +/** + * @file + * @brief Linker command/script file + * + * This is the linker script for both standard images and XIP images. */ #include diff --git a/arch/x86/platforms/qemu_x86/platform.c b/arch/x86/platforms/qemu_x86/platform.c index 69e2abc28e8..19a6ac2e071 100644 --- a/arch/x86/platforms/qemu_x86/platform.c +++ b/arch/x86/platforms/qemu_x86/platform.c @@ -1,5 +1,3 @@ -/* ia32.c - system/hardware module for the QEMU platform */ - /* * Copyright (c) 2011-2015, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief System/hardware module for the QEMU platform + * * This module provides routines to initialize and support board-level hardware * for the QEMU platform. */ diff --git a/arch/x86/platforms/quark_d2000/linker.cmd b/arch/x86/platforms/quark_d2000/linker.cmd index bc0323284ff..bb2a2052053 100644 --- a/arch/x86/platforms/quark_d2000/linker.cmd +++ b/arch/x86/platforms/quark_d2000/linker.cmd @@ -1,5 +1,3 @@ -/* linker.cmd - Linker command/script file */ - /* * Copyright (c) 2015 Wind River Systems, Inc. * @@ -16,10 +14,12 @@ * limitations under the License. */ -/* -DESCRIPTION -This is the linker script for both standard images and XIP images. -*/ +/** + * @file + * @brief Linker command/script file + * + * This is the linker script for both standard images and XIP images. + */ #include diff --git a/arch/x86/platforms/quark_d2000/system.c b/arch/x86/platforms/quark_d2000/system.c index 22d87cca131..46049f86863 100644 --- a/arch/x86/platforms/quark_d2000/system.c +++ b/arch/x86/platforms/quark_d2000/system.c @@ -1,5 +1,3 @@ -/* system.c - system/hardware module for the Quark D2000 BSP */ - /* * Copyright (c) 2015 Wind River Systems, Inc. * @@ -16,11 +14,13 @@ * limitations under the License. */ -/* -DESCRIPTION -This module provides routines to initialize and support board-level -hardware for the Quark D2000 BSP. -*/ +/** + * @file + * @brief System/hardware module for the Quark D2000 BSP + * + * This module provides routines to initialize and support board-level + * hardware for the Quark D2000 BSP. + */ #include #include diff --git a/arch/x86/platforms/quark_se/linker.cmd b/arch/x86/platforms/quark_se/linker.cmd index a97211f1466..321d448df8d 100644 --- a/arch/x86/platforms/quark_se/linker.cmd +++ b/arch/x86/platforms/quark_se/linker.cmd @@ -1,5 +1,3 @@ -/* linker.cmd - Linker command/script file */ - /* * Copyright (c) 2015 Wind River Systems, Inc. * @@ -16,10 +14,12 @@ * limitations under the License. */ -/* -DESCRIPTION -This is the linker script for both standard images and XIP images. -*/ +/** + * @file + * @brief Linker command/script file + * + * This is the linker script for both standard images and XIP images. + */ #include diff --git a/arch/x86/platforms/quark_se/system.c b/arch/x86/platforms/quark_se/system.c index f445d7ec9d0..986c2269021 100644 --- a/arch/x86/platforms/quark_se/system.c +++ b/arch/x86/platforms/quark_se/system.c @@ -1,5 +1,3 @@ -/* system.c - system/hardware module for the Quark SE BSP */ - /* * Copyright (c) 2015 Wind River Systems, Inc. * @@ -16,11 +14,13 @@ * limitations under the License. */ -/* -DESCRIPTION -This module provides routines to initialize and support board-level -hardware for the Quark SE BSP. -*/ +/** + * @file + * @brief System/hardware module for the Quark SE BSP + * + * This module provides routines to initialize and support board-level + * hardware for the Quark SE BSP. + */ #include #include diff --git a/drivers/console/uart_console.c b/drivers/console/uart_console.c index ec980256d59..bef608be2b2 100644 --- a/drivers/console/uart_console.c +++ b/drivers/console/uart_console.c @@ -1,5 +1,3 @@ -/* uart_console.c - UART-driven console */ - /* * Copyright (c) 2011-2012, 2014-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief UART-driven console + * * * Serial console driver. * Hooks into the printk and fputc (for printf) modules. Poll driven. diff --git a/drivers/interrupt_controller/arcv2_irq_unit.c b/drivers/interrupt_controller/arcv2_irq_unit.c index 4665a169c59..81a4f4f0c64 100644 --- a/drivers/interrupt_controller/arcv2_irq_unit.c +++ b/drivers/interrupt_controller/arcv2_irq_unit.c @@ -1,5 +1,3 @@ -/* arcv2_irq_unit.c - ARCv2 Interrupt Unit device driver */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARCv2 Interrupt Unit device driver + * * The ARCv2 interrupt unit has 16 allocated exceptions associated with * vectors 0 to 15 and 240 interrupts associated with vectors 16 to 255. * The interrupt unit is optional in the ARCv2-based processors. When diff --git a/drivers/interrupt_controller/i8259.c b/drivers/interrupt_controller/i8259.c index d17bf123267..2e985baad11 100644 --- a/drivers/interrupt_controller/i8259.c +++ b/drivers/interrupt_controller/i8259.c @@ -1,5 +1,3 @@ -/* i8259.c - Disable Intel 8259A PIC (Programmable Interrupt Controller) */ - /* * Copyright (c) 2010-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Disable Intel 8259A PIC (Programmable Interrupt Controller) + * * This module disables the Intel 8259A PIC (Programmable Interrupt Controller) * to prevent it from generating spurious interrupts. */ diff --git a/drivers/interrupt_controller/loapic_intr.c b/drivers/interrupt_controller/loapic_intr.c index 06c0a947b26..e876eddb00d 100644 --- a/drivers/interrupt_controller/loapic_intr.c +++ b/drivers/interrupt_controller/loapic_intr.c @@ -1,5 +1,3 @@ -/* loApicIntr.c - Intel Pentium[234] Local APIC/xAPIC driver */ - /* * Copyright (c) 1984-2008, 2011-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief LoApicIntr.c - Intel Pentium[234] Local APIC/xAPIC driver + * * This module is a driver for the local APIC/xAPIC (Advanced Programmable * Interrupt Controller) in P6 (PentiumPro, II, III) family processors * and P7 (Pentium4) family processors. The local APIC/xAPIC is included diff --git a/drivers/interrupt_controller/system_apic.c b/drivers/interrupt_controller/system_apic.c index 37ab4972ee6..ab36927c263 100644 --- a/drivers/interrupt_controller/system_apic.c +++ b/drivers/interrupt_controller/system_apic.c @@ -14,7 +14,7 @@ * limitations under the License. */ -/* +/** * @file * @brief system module for variants with LOAPIC * diff --git a/drivers/pci/pci.c b/drivers/pci/pci.c index d7522fe64a7..748bb13ceca 100644 --- a/drivers/pci/pci.c +++ b/drivers/pci/pci.c @@ -1,5 +1,3 @@ -/* pci.c - PCI probe and information routines */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief PCI probe and information routines + * * Module implements routines for PCI bus initialization and query. * * USAGE diff --git a/drivers/pci/pci_config.c b/drivers/pci/pci_config.c index 37e7bb89af0..0fcdeda7bf6 100644 --- a/drivers/pci/pci_config.c +++ b/drivers/pci/pci_config.c @@ -1,5 +1,3 @@ -/* pci_config.c - PCI bus support */ - /* * Copyright (c) 2009-2010, 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief PCI bus support + * * * This module implements the PCI config space access functions * diff --git a/drivers/pci/pci_interface.c b/drivers/pci/pci_interface.c index 337deb31425..11a0d6e9141 100644 --- a/drivers/pci/pci_interface.c +++ b/drivers/pci/pci_interface.c @@ -1,5 +1,3 @@ -/* pci_interface.c - PCI bus support */ - /* * Copyright (c) 2009-2011, 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief PCI bus support + * * * This module implements the PCI H/W access functions. */ diff --git a/drivers/pci/pci_legacy_bridge.c b/drivers/pci/pci_legacy_bridge.c index e2ca3dce295..b5e31a0aef4 100644 --- a/drivers/pci/pci_legacy_bridge.c +++ b/drivers/pci/pci_legacy_bridge.c @@ -1,5 +1,3 @@ -/* pci_legacy_bridge.c - PCI legacy bridge device driver */ - /* * Copyright (c) 2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief PCI legacy bridge device driver + * * Module provides routines for utilizing the PCI legacy bridge, including * detection of the bridge and using the bridge to configure the routing between * PCI interrupt pins and IRQs. diff --git a/drivers/random/rand32_timer.c b/drivers/random/rand32_timer.c index 1932a1f93be..635fe2c97f4 100644 --- a/drivers/random/rand32_timer.c +++ b/drivers/random/rand32_timer.c @@ -1,5 +1,3 @@ -/* non-random number generator based on system timer */ - /* * Copyright (c) 2013-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Non-random number generator based on system timer + * * This module provides a non-random implementation of sys_rand32_get(), which * is not meant to be used in a final product as a truly random number * generator. It was provided to allow testing on a platform that does not (yet) diff --git a/drivers/random/rand32_timestamp.c b/drivers/random/rand32_timestamp.c index 9d6ad841a89..f872d53f23c 100644 --- a/drivers/random/rand32_timestamp.c +++ b/drivers/random/rand32_timestamp.c @@ -1,5 +1,3 @@ -/* non-random number generator based on x86 CPU timestamp */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Non-random number generator based on x86 CPU timestamp + * * This module provides a non-random implementation of sys_rand32_get(), which * is not meant to be used in a final product as a truly random number * generator. It was provided to allow testing on a platform that does not (yet) diff --git a/drivers/timer/arcv2_timer0.c b/drivers/timer/arcv2_timer0.c index c59895ef1e6..c7d756e8d43 100644 --- a/drivers/timer/arcv2_timer0.c +++ b/drivers/timer/arcv2_timer0.c @@ -1,5 +1,3 @@ -/* arcv2_timer0.c - ARC timer 0 device driver */ - /* * Copyright (c) 2014-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARC timer 0 device driver + * * This module implements a kernel device driver for the ARCv2 processor timer 0 * and provides the standard "system clock driver" interfaces. * diff --git a/drivers/timer/cortex_m_systick.c b/drivers/timer/cortex_m_systick.c index dca3c685543..f5c14392f67 100644 --- a/drivers/timer/cortex_m_systick.c +++ b/drivers/timer/cortex_m_systick.c @@ -1,5 +1,3 @@ -/* ARM Cortex-M systick device driver */ - /* * Copyright (c) 2013-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM Cortex-M systick device driver + * * This module implements the kernel's CORTEX-M ARM's systick device driver. * It provides the standard kernel "system clock driver" interfaces. * diff --git a/drivers/timer/cortex_m_systick_gdb.S b/drivers/timer/cortex_m_systick_gdb.S index e6edb8f26b3..1f1eafa5894 100644 --- a/drivers/timer/cortex_m_systick_gdb.S +++ b/drivers/timer/cortex_m_systick_gdb.S @@ -1,5 +1,3 @@ -/* ARM Cortex-M systick handler stub for GDB debugging */ - /* * Copyright (c) 2014-2015 Wind River Systems, Inc. * @@ -16,10 +14,12 @@ * limitations under the License. */ -/* -DESCRIPTION -GDB stub needed before the real systick handler runs to be able to display the -correct state of the thread that was interrupted. +/** + * @file + * @brief ARM Cortex-M systick handler stub for GDB debugging + * + * GDB stub needed before the real systick handler runs to be able to display the + * correct state of the thread that was interrupted. */ #define _ASMLANGUAGE diff --git a/drivers/timer/hpet.c b/drivers/timer/hpet.c index f09285fcfbf..bf2b2e49652 100644 --- a/drivers/timer/hpet.c +++ b/drivers/timer/hpet.c @@ -1,5 +1,3 @@ -/* hpet.c - Intel HPET device driver */ - /* * Copyright (c) 2012-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Intel HPET device driver + * * This module implements a kernel device driver for the Intel High Precision * Event Timer (HPET) device, and provides the standard "system clock driver" * interfaces. diff --git a/drivers/timer/sys_clock_init.c b/drivers/timer/sys_clock_init.c index b5cdad278fe..795234a8a57 100644 --- a/drivers/timer/sys_clock_init.c +++ b/drivers/timer/sys_clock_init.c @@ -1,5 +1,3 @@ -/* initialize system clock driver */ - /* * Copyright (c) 2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Initialize system clock driver + * * Initializing the timer driver is done in this module to reduce code * duplication. Although both nanokernel and microkernel systems initialize * the timer driver at the same point, the two systems differ in when the system @@ -26,7 +26,7 @@ * microkernel system all system clock ticks are deferred (and stored on the * kernel server command stack) until the kernel server fiber starts and begins * processing any queued ticks. -*/ + */ #include #include diff --git a/include/arch/arc/arch.h b/include/arch/arc/arch.h index e5d2f1a0d28..531613a95c0 100644 --- a/include/arch/arc/arch.h +++ b/include/arch/arc/arch.h @@ -1,5 +1,3 @@ -/* arch.h - ARC specific nanokernel interface header */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARC specific nanokernel interface header + * * This header contains the ARC specific nanokernel interface. It is * included by the nanokernel interface architecture-abstraction header * (nanokernel/cpu.h) diff --git a/include/arch/arc/v2/aux_regs.h b/include/arch/arc/v2/aux_regs.h index ebc6f2b9f2c..7414ef336cd 100644 --- a/include/arch/arc/v2/aux_regs.h +++ b/include/arch/arc/v2/aux_regs.h @@ -1,5 +1,3 @@ -/* aux_regs.h - ARCv2 auxiliary registers definitions */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARCv2 auxiliary registers definitions + * * * Definitions for auxiliary registers. */ diff --git a/include/arch/arc/v2/error.h b/include/arch/arc/v2/error.h index c6d3395d70c..ce981fec46c 100644 --- a/include/arch/arc/v2/error.h +++ b/include/arch/arc/v2/error.h @@ -1,5 +1,3 @@ -/* v2/error.h - ARCv2 public error handling */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARCv2 public error handling + * * ARC-specific nanokernel error handling interface. Included by ARC/arch.h. */ diff --git a/include/arch/arc/v2/exc.h b/include/arch/arc/v2/exc.h index ffe4a3ef79b..b86d2fe1a8a 100644 --- a/include/arch/arc/v2/exc.h +++ b/include/arch/arc/v2/exc.h @@ -1,5 +1,3 @@ -/* v2/exc.h - ARCv2 public exception handling */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARCv2 public exception handling + * * ARC-specific nanokernel exception handling interface. Included by ARC/arch.h. */ diff --git a/include/arch/arc/v2/ffs.h b/include/arch/arc/v2/ffs.h index e6f763eb1b4..fc0c1de351b 100644 --- a/include/arch/arc/v2/ffs.h +++ b/include/arch/arc/v2/ffs.h @@ -1,5 +1,3 @@ -/* v2/ffs.h - ARCv2 public nanokernel find-first-set interface */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARCv2 public nanokernel find-first-set interface + * * ARC-specific nanokernel ffs interface. Included by ARC/arch.h. */ diff --git a/include/arch/arc/v2/irq.h b/include/arch/arc/v2/irq.h index bf4cd2226b7..782b5baea55 100644 --- a/include/arch/arc/v2/irq.h +++ b/include/arch/arc/v2/irq.h @@ -1,5 +1,3 @@ -/* arc/v2/irq.h - ARCv2 public interrupt handling */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARCv2 public interrupt handling + * * ARCv2 nanokernel interrupt handling interface. Included by ARC/v2/arch.h. */ diff --git a/include/arch/arc/v2/misc.h b/include/arch/arc/v2/misc.h index 63e11c69a7e..40168d82e22 100644 --- a/include/arch/arc/v2/misc.h +++ b/include/arch/arc/v2/misc.h @@ -1,5 +1,3 @@ -/* arc/v2/misc.h - ARCv2 public nanokernel miscellaneous */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARCv2 public nanokernel miscellaneous + * * ARC-specific nanokernel miscellaneous interface. Included by arc/arch.h. */ diff --git a/include/arch/arm/arch.h b/include/arch/arm/arch.h index 224977c5acb..32860d95f23 100644 --- a/include/arch/arm/arch.h +++ b/include/arch/arm/arch.h @@ -1,5 +1,3 @@ -/* arch.h - ARM specific nanokernel interface header */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM specific nanokernel interface header + * * This header contains the ARM specific nanokernel interface. It is * included by the nanokernel interface architecture-abstraction header * (nanokernel/cpu.h) diff --git a/include/arch/arm/cortex_m/error.h b/include/arch/arm/cortex_m/error.h index aa4d98991b5..cc4f820c090 100644 --- a/include/arch/arm/cortex_m/error.h +++ b/include/arch/arm/cortex_m/error.h @@ -1,5 +1,3 @@ -/* cortex_m/error.h - Cortex-M public error handling */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Cortex-M public error handling + * * ARM-specific nanokernel error handling interface. Included by ARM/arch.h. */ diff --git a/include/arch/arm/cortex_m/exc.h b/include/arch/arm/cortex_m/exc.h index 4674222574a..740dd07c634 100644 --- a/include/arch/arm/cortex_m/exc.h +++ b/include/arch/arm/cortex_m/exc.h @@ -1,5 +1,3 @@ -/* cortex_m/exc.h - Cortex-M public exception handling */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Cortex-M public exception handling + * * ARM-specific nanokernel exception handling interface. Included by ARM/arch.h. */ diff --git a/include/arch/arm/cortex_m/gdb_stub.h b/include/arch/arm/cortex_m/gdb_stub.h index baf94b52eb4..9b3ec0cbf51 100644 --- a/include/arch/arm/cortex_m/gdb_stub.h +++ b/include/arch/arm/cortex_m/gdb_stub.h @@ -1,5 +1,3 @@ -/* gdb_stub.h - extra work performed upon exception entry/exit for GDB */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Extra work performed upon exception entry/exit for GDB + * * * Prep work done when entering exceptions consists of saving the callee-saved * registers before they get used by exception handlers, and recording the fact diff --git a/include/arch/arm/cortex_m/irq.h b/include/arch/arm/cortex_m/irq.h index 230888602af..f48d464f0c7 100644 --- a/include/arch/arm/cortex_m/irq.h +++ b/include/arch/arm/cortex_m/irq.h @@ -1,5 +1,3 @@ -/* cortex_m/irq.h - Cortex-M public interrupt handling */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Cortex-M public interrupt handling + * * ARM-specific nanokernel interrupt handling interface. Included by ARM/arch.h. */ diff --git a/include/arch/arm/cortex_m/memory_map-m3-m4.h b/include/arch/arm/cortex_m/memory_map-m3-m4.h index 738a69e10c0..fb820bb3d98 100644 --- a/include/arch/arm/cortex_m/memory_map-m3-m4.h +++ b/include/arch/arm/cortex_m/memory_map-m3-m4.h @@ -1,5 +1,3 @@ -/* memory_map-m3-m4.h - ARM CORTEX-M3/M4 memory map */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM CORTEX-M3/M4 memory map + * * This module contains definitions for the memory map parts specific to the * CORTEX-M3/M4 series of processors. It is included by * nanokernel/ARM/memory_map.h diff --git a/include/arch/arm/cortex_m/memory_map.h b/include/arch/arm/cortex_m/memory_map.h index 62c23b58b52..f91397475df 100644 --- a/include/arch/arm/cortex_m/memory_map.h +++ b/include/arch/arm/cortex_m/memory_map.h @@ -1,5 +1,3 @@ -/* memory_map.h - ARM CORTEX-M memory map */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM CORTEX-M memory map + * * This module contains definitions for the memory map of the CORTEX-M series of * processors. */ diff --git a/include/arch/arm/cortex_m/misc.h b/include/arch/arm/cortex_m/misc.h index 88da1811966..7ac6c536410 100644 --- a/include/arch/arm/cortex_m/misc.h +++ b/include/arch/arm/cortex_m/misc.h @@ -1,5 +1,3 @@ -/* cortex_m/misc.h - Cortex-M public nanokernel miscellaneous */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Cortex-M public nanokernel miscellaneous + * * ARM-specific nanokernel miscellaneous interface. Included by ARM/arch.h. */ diff --git a/include/arch/arm/cortex_m/nvic.h b/include/arch/arm/cortex_m/nvic.h index 76c6c51e42b..178531d15df 100644 --- a/include/arch/arm/cortex_m/nvic.h +++ b/include/arch/arm/cortex_m/nvic.h @@ -1,5 +1,3 @@ -/* nvic.c - ARM CORTEX-M Series Nested Vector Interrupt Controller */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Nvic.c - ARM CORTEX-M Series Nested Vector Interrupt Controller + * * Provide an interface to the Nested Vectored Interrupt Controller found on * ARM Cortex-M processors. * diff --git a/include/arch/arm/cortex_m/scb.h b/include/arch/arm/cortex_m/scb.h index 6a70ee8b5cf..f47b3b285b5 100644 --- a/include/arch/arm/cortex_m/scb.h +++ b/include/arch/arm/cortex_m/scb.h @@ -1,5 +1,3 @@ -/* scb.h - ARM CORTEX-M System Control Block interface */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM CORTEX-M System Control Block interface + * * Provide an interface to the System Control Block found on ARM Cortex-M * processors. * diff --git a/include/arch/arm/cortex_m/scripts/linker.cmd b/include/arch/arm/cortex_m/scripts/linker.cmd index db30a3f1068..91f707c429e 100644 --- a/include/arch/arm/cortex_m/scripts/linker.cmd +++ b/include/arch/arm/cortex_m/scripts/linker.cmd @@ -1,5 +1,3 @@ -/* linker.cmd - Linker command/script file */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,9 +14,11 @@ * limitations under the License. */ -/* -DESCRIPTION -Linker script for the Cortex-M3 platform. +/** + * @file + * @brief Linker command/script file + * + * Linker script for the Cortex-M3 platform. */ #define _LINKER diff --git a/include/arch/arm/cortex_m/scs.h b/include/arch/arm/cortex_m/scs.h index d6ea6aac426..9f13ec36a65 100644 --- a/include/arch/arm/cortex_m/scs.h +++ b/include/arch/arm/cortex_m/scs.h @@ -1,5 +1,3 @@ -/* scs.h - ARM CORTEX-M System Control Space */ - /* * Copyright (c) 2013-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief ARM CORTEX-M System Control Space + * * Define the System Control Space for the CORTEX-M series of processors and * provide an interface for miscellaneous SCS functionalities. * diff --git a/include/arch/x86/linker-common-sections.h b/include/arch/x86/linker-common-sections.h index b440b869c8d..1dbe3bf6aeb 100644 --- a/include/arch/x86/linker-common-sections.h +++ b/include/arch/x86/linker-common-sections.h @@ -1,5 +1,3 @@ -/* linker-common-sections.h - common linker sections */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Common linker sections + * * This script defines the memory location of the various sections that make up * a Zephyr Kernel image. This file is used by the linker. * diff --git a/include/arch/x86/linker-defs-arch.h b/include/arch/x86/linker-defs-arch.h index 93aaeadc89f..9ebb1144f40 100644 --- a/include/arch/x86/linker-defs-arch.h +++ b/include/arch/x86/linker-defs-arch.h @@ -1,5 +1,3 @@ -/* linker-defs-arch.h - Intel commonly used macro and defines for linker script */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Intel commonly used macro and defines for linker script + * * Commonly used macros and defines for linker script. */ #ifndef _LINKERDEFSARCH_H diff --git a/include/arch/x86/segselect.h b/include/arch/x86/segselect.h index 70d63c0d247..d241c3b7731 100644 --- a/include/arch/x86/segselect.h +++ b/include/arch/x86/segselect.h @@ -1,5 +1,3 @@ -/* segselect.h - IA-32 segment selector header */ - /* * Copyright (c) 2012-2014, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief IA-32 segment selector header + * * This header contains the IA-32 segment selector defintions. These are * extracted into their own file so they can be shared with the host tools. */ diff --git a/include/drivers/k20_mcg.h b/include/drivers/k20_mcg.h index 82ff58daef6..6a1309fae01 100644 --- a/include/drivers/k20_mcg.h +++ b/include/drivers/k20_mcg.h @@ -1,5 +1,3 @@ -/* K20 Microprocessor MCG register definitions */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief K20 Microprocessor MCG register definitions + * * This module defines the Multipurpose Clock Generator (MCG) and Oscillator * (OSC) registers for the K20 Family of microprocessors. */ diff --git a/include/drivers/k20_pcr.h b/include/drivers/k20_pcr.h index e5e0fb8393d..fd836579b6e 100644 --- a/include/drivers/k20_pcr.h +++ b/include/drivers/k20_pcr.h @@ -1,5 +1,3 @@ -/* Freescale K20 microprocessor Pin Control register definitions */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Freescale K20 microprocessor Pin Control register definitions + * * This module defines the PCR (Port/Pin Control/Configuration Registers) for * the K20 Family of microprocessors */ diff --git a/include/drivers/k20_watchdog.h b/include/drivers/k20_watchdog.h index db236d1e235..80caaa2e8b7 100644 --- a/include/drivers/k20_watchdog.h +++ b/include/drivers/k20_watchdog.h @@ -1,5 +1,3 @@ -/* Freescale K20 microprocessor Watch Dog registers */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Freescale K20 microprocessor Watch Dog registers + * * This module defines Watch Dog Registers for the K20 Family of microprocessors */ diff --git a/include/drivers/k6x_mpu.h b/include/drivers/k6x_mpu.h index 99a1f6cc39d..3b9db17023d 100644 --- a/include/drivers/k6x_mpu.h +++ b/include/drivers/k6x_mpu.h @@ -1,5 +1,3 @@ -/* Freescale K6x microprocessor MPU register definitions */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Freescale K6x microprocessor MPU register definitions + * * This module defines the Memory Protection Unit (MPU) Registers for the K6x * Family of microprocessors. * NOTE: Not all the registers are currently defined here - only those that are diff --git a/include/drivers/k6x_pmc.h b/include/drivers/k6x_pmc.h index 69b977853d9..88eed057078 100644 --- a/include/drivers/k6x_pmc.h +++ b/include/drivers/k6x_pmc.h @@ -1,5 +1,3 @@ -/* Freescale K6x microprocessor PMC register definitions */ - /* * Copyright (c) 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Freescale K6x microprocessor PMC register definitions + * * This module defines the Power Management Controller (PMC) registers for the * K6x Family of microprocessors. * NOTE: Not all the registers are currently defined here - only those that are diff --git a/include/drivers/pci/pci.h b/include/drivers/pci/pci.h index eb7033188a3..dcfc6185194 100644 --- a/include/drivers/pci/pci.h +++ b/include/drivers/pci/pci.h @@ -1,5 +1,3 @@ -/* pci.h - PCI probe and information routines */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief PCI probe and information routines + * * Module declares routines of PCI bus initialization and query */ diff --git a/include/drivers/rand32.h b/include/drivers/rand32.h index 087b6427a76..7ab3e2781c2 100644 --- a/include/drivers/rand32.h +++ b/include/drivers/rand32.h @@ -1,5 +1,3 @@ -/* rand32.h - random number generator header file */ - /* * Copyright (c) 2013-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Random number generator header file + * * This header file declares prototypes for the kernel's random number generator * APIs. * diff --git a/include/drivers/system_timer.h b/include/drivers/system_timer.h index 6c4114aeccd..b912ad854c9 100644 --- a/include/drivers/system_timer.h +++ b/include/drivers/system_timer.h @@ -1,5 +1,3 @@ -/* system_timer.h - timer driver API */ - /* * Copyright (c) 2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Timer driver API + * * * Declare API implemented by system timer driver and used by kernel components. */ diff --git a/include/linker-tool-gcc.h b/include/linker-tool-gcc.h index 0b99fea941f..609cedc3552 100644 --- a/include/linker-tool-gcc.h +++ b/include/linker-tool-gcc.h @@ -1,5 +1,3 @@ -/* linker-tool-gcc.h - GCC toolchain linker defs */ - /* * Copyright (c) 2013-2014, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief GCC toolchain linker defs + * * This header file defines the necessary macros used by the linker script for * use with the GCC linker. */ diff --git a/include/linker-tool.h b/include/linker-tool.h index 0fafcc9bb2e..82d7ee4b6e8 100644 --- a/include/linker-tool.h +++ b/include/linker-tool.h @@ -1,5 +1,3 @@ -/* linker-tool.h - toolchain-agnostic linker defs */ - /* * Copyright (c) 2013-2014, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Toolchain-agnostic linker defs + * * This header file is used to automatically select the proper set of macro * definitions (based on the toolchain) for the linker script. */ diff --git a/include/misc/__assert.h b/include/misc/__assert.h index acd6f199eee..8b26620bcd0 100644 --- a/include/misc/__assert.h +++ b/include/misc/__assert.h @@ -1,5 +1,3 @@ -/* __assert.h - debug aid */ - /* * Copyright (c) 2011-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Debug aid + * * * The __ASSERT() macro can be used inside kernel code. * diff --git a/include/misc/dlist.h b/include/misc/dlist.h index 3b5bd702147..97bcf3dd3b1 100644 --- a/include/misc/dlist.h +++ b/include/misc/dlist.h @@ -1,5 +1,3 @@ -/* dlist.h - doubly-linked list inline implementation */ - /* * Copyright (c) 2013-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Doubly-linked list inline implementation + * * Doubly-linked list implementation. * * The lists are expected to be initialized such that both the head and tail diff --git a/include/misc/event_logger.h b/include/misc/event_logger.h index 90a23d82acb..0b02d9f56d1 100644 --- a/include/misc/event_logger.h +++ b/include/misc/event_logger.h @@ -14,7 +14,7 @@ * limitations under the License. */ -/* +/** * @file * @brief Event logger support. */ diff --git a/include/misc/kernel_event_logger.h b/include/misc/kernel_event_logger.h index 2bfc2c98904..38b1cb40865 100644 --- a/include/misc/kernel_event_logger.h +++ b/include/misc/kernel_event_logger.h @@ -14,7 +14,7 @@ * limitations under the License. */ -/* +/** * @file * @brief Kernel event logger support. */ diff --git a/include/misc/util.h b/include/misc/util.h index 41b3004694b..4b1c1642d44 100644 --- a/include/misc/util.h +++ b/include/misc/util.h @@ -1,5 +1,3 @@ -/* util.h - misc utilities */ - /* * Copyright (c) 2011-2014, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Misc utilities + * * Misc utilities usable by nanokernel, microkernel, and application code. */ diff --git a/include/sections.h b/include/sections.h index 196de7bd1b5..0136408d9f6 100644 --- a/include/sections.h +++ b/include/sections.h @@ -1,5 +1,3 @@ -/* sections.h - Definitions of various linker Sections. */ - /* * Copyright (c) 2013-2014, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Definitions of various linker Sections. + * * Linker Section declarations used by linker script, C files and Assembly * files. */ diff --git a/include/sw_isr_table.h b/include/sw_isr_table.h index 793c26505fa..5d7ca2774f6 100644 --- a/include/sw_isr_table.h +++ b/include/sw_isr_table.h @@ -1,5 +1,3 @@ -/* sw_isr_table.h - software-managed ISR table */ - /* * Copyright (c) 2014, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Software-managed ISR table + * * Data types for a software-managed ISR table, with a parameter per-ISR. */ diff --git a/include/sys_clock.h b/include/sys_clock.h index 4fa1149e539..4d75a9c7a3e 100644 --- a/include/sys_clock.h +++ b/include/sys_clock.h @@ -1,5 +1,3 @@ -/* Variables needed needed for system clock */ - /* * Copyright (c) 2014-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Variables needed needed for system clock + * * * Declare variables used by both system timer device driver and kernel * components that use timer functionality. diff --git a/include/toolchain.h b/include/toolchain.h index 5208dd9cf29..37bf8f491df 100644 --- a/include/toolchain.h +++ b/include/toolchain.h @@ -1,5 +1,3 @@ -/* toolchain.h - macros to abstract toolchain specific capabilities */ - /* * Copyright (c) 2010-2014, Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Macros to abstract toolchain specific capabilities + * * This file contains various macros to abstract compiler capabilities that * utilize toolchain specific attributes and/or pragmas. */ diff --git a/include/toolchain/common.h b/include/toolchain/common.h index ea2dc61da53..7ee41bb409d 100644 --- a/include/toolchain/common.h +++ b/include/toolchain/common.h @@ -1,5 +1,3 @@ -/* toolchain/common.h - common toolchain abstraction */ - /* * Copyright (c) 2010-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Common toolchain abstraction + * * Macros to abstract compiler capabilities (common to all toolchains). */ diff --git a/include/toolchain/gcc.h b/include/toolchain/gcc.h index ce4f1e22a22..dc533dc21dd 100644 --- a/include/toolchain/gcc.h +++ b/include/toolchain/gcc.h @@ -1,5 +1,3 @@ -/* toolchain/gcc.h - GCC toolchain abstraction */ - /* * Copyright (c) 2010-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief GCC toolchain abstraction + * * Macros to abstract compiler capabilities for GCC toolchain. */ #include diff --git a/kernel/microkernel/include/kernel_main.h b/kernel/microkernel/include/kernel_main.h index 97adf1ba642..742058b0e31 100644 --- a/kernel/microkernel/include/kernel_main.h +++ b/kernel/microkernel/include/kernel_main.h @@ -14,7 +14,7 @@ * limitations under the License. */ -/* +/** * @file * @brief Non-public microkernel APIs referenced by kernel_main.c. */ diff --git a/kernel/microkernel/k_idle.c b/kernel/microkernel/k_idle.c index b0b62814f1c..16e5319c111 100644 --- a/kernel/microkernel/k_idle.c +++ b/kernel/microkernel/k_idle.c @@ -1,5 +1,3 @@ -/* k_idle.c - microkernel idle logic */ - /* * Copyright (c) 1997-2010, 2012-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Microkernel idle logic + * * Microkernel idle logic. Different forms of idling are performed by the idle * task, depending on how the kernel is configured. */ diff --git a/kernel/microkernel/k_memory_pool.c b/kernel/microkernel/k_memory_pool.c index 07b0aeef730..2239c25e13e 100644 --- a/kernel/microkernel/k_memory_pool.c +++ b/kernel/microkernel/k_memory_pool.c @@ -1,5 +1,3 @@ -/* memory pool kernel services */ - /* * Copyright (c) 1997-2010, 2013-2014 Wind River Systems, Inc. * @@ -300,7 +298,9 @@ static char *search_block_on_frag_level(struct pool_block *pfraglevelinfo, * * @brief Recursively get a block, doing fragmentation if necessary * - * [NEED A BETTER DESCRIPTION HERE] + * @file + * @brief Memory pool kernel services + * * * not implemented: check if we go below the minimal number of blocks with * the maximum size diff --git a/kernel/microkernel/k_nop.c b/kernel/microkernel/k_nop.c index e748deadadf..089d0b60903 100644 --- a/kernel/microkernel/k_nop.c +++ b/kernel/microkernel/k_nop.c @@ -1,5 +1,3 @@ -/* "do nothing" kernel service */ - /* * Copyright (c) 1997-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief "do nothing" kernel service + * * This module provides a "do nothing" kernel service. * * This service is primarily used by other kernel services that need a way to diff --git a/kernel/microkernel/k_pipe.c b/kernel/microkernel/k_pipe.c index 1e6fd79eeae..dbebb5e1c47 100644 --- a/kernel/microkernel/k_pipe.c +++ b/kernel/microkernel/k_pipe.c @@ -14,7 +14,7 @@ * limitations under the License. */ -/* +/** * @file * @brief Pipe kernel services */ diff --git a/kernel/microkernel/k_server.c b/kernel/microkernel/k_server.c index db0352b5800..9eecc69032a 100644 --- a/kernel/microkernel/k_server.c +++ b/kernel/microkernel/k_server.c @@ -1,5 +1,3 @@ -/* k_server.c - microkernel server */ - /* * Copyright (c) 2010, 2012-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Microkernel server + * * This module implements the microkernel server, which processes service * requests from tasks (and, less commonly, fibers and ISRs). The requests are * service by a high priority fiber, thereby ensuring that requests are diff --git a/kernel/microkernel/k_ticker.c b/kernel/microkernel/k_ticker.c index a4530351214..468ed1e323c 100644 --- a/kernel/microkernel/k_ticker.c +++ b/kernel/microkernel/k_ticker.c @@ -1,5 +1,3 @@ -/* k_ticker.c - microkernel tick event handler */ - /* * Copyright (c) 1997-2010, 2012-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Microkernel tick event handler + * * This module implements the microkernel's tick event handler. */ diff --git a/kernel/nanokernel/compiler_stack_protect.c b/kernel/nanokernel/compiler_stack_protect.c index 3efc44dbc8b..7e823f32ac1 100644 --- a/kernel/nanokernel/compiler_stack_protect.c +++ b/kernel/nanokernel/compiler_stack_protect.c @@ -1,5 +1,3 @@ -/* compiler_stack_protect.c - Compiler stack protection (kernel part) */ - /* * Copyright (c) 2012-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Compiler stack protection (kernel part) + * * This module provides functions to support compiler stack protection * using canaries. This feature is enabled with configuration * CONFIG_STACK_CANARIES=y. diff --git a/kernel/nanokernel/event_logger.c b/kernel/nanokernel/event_logger.c index d1cd6d6cc7c..fbc19c3db0c 100644 --- a/kernel/nanokernel/event_logger.c +++ b/kernel/nanokernel/event_logger.c @@ -14,7 +14,7 @@ * limitations under the License. */ -/* +/** * @file * @brief Event logger support. */ diff --git a/kernel/nanokernel/idle.c b/kernel/nanokernel/idle.c index 7b038c27f8f..6bef0ac13b4 100644 --- a/kernel/nanokernel/idle.c +++ b/kernel/nanokernel/idle.c @@ -1,5 +1,3 @@ -/* nanokernel idle support */ - /* * Copyright (c) 2011-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Nanokernel idle support + * * This module provides routines to set the idle field in the nanokernel * data structure. */ diff --git a/kernel/nanokernel/include/gen_offset.h b/kernel/nanokernel/include/gen_offset.h index 10dc2694844..d3c19b3e803 100644 --- a/kernel/nanokernel/include/gen_offset.h +++ b/kernel/nanokernel/include/gen_offset.h @@ -1,5 +1,3 @@ -/* gen_offset.h - macros to generate structure member offset definitions */ - /* * Copyright (c) 2010, 2012, 2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Macros to generate structure member offset definitions + * * This header contains macros to allow a nanokernel implementation to * generate absolute symbols whose values represents the member offsets for * various nanokernel structures. These absolute symbols are typically diff --git a/kernel/nanokernel/include/nano_internal.h b/kernel/nanokernel/include/nano_internal.h index d31a6b4df02..166c1edb735 100644 --- a/kernel/nanokernel/include/nano_internal.h +++ b/kernel/nanokernel/include/nano_internal.h @@ -1,5 +1,3 @@ -/* architecture-independent private nanokernel APIs */ - /* * Copyright (c) 2010-2012, 2014-2015 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Architecture-independent private nanokernel APIs + * * This file contains private nanokernel APIs that are not * architecture-specific. */ diff --git a/kernel/nanokernel/kernel_event_logger.c b/kernel/nanokernel/kernel_event_logger.c index f029b474059..fb4bb693100 100644 --- a/kernel/nanokernel/kernel_event_logger.c +++ b/kernel/nanokernel/kernel_event_logger.c @@ -14,7 +14,7 @@ * limitations under the License. */ -/* +/** * @file * @brief Kernel event logger support. */ diff --git a/kernel/nanokernel/nano_context.c b/kernel/nanokernel/nano_context.c index 363ac1bbe4d..9970229cc12 100644 --- a/kernel/nanokernel/nano_context.c +++ b/kernel/nanokernel/nano_context.c @@ -1,5 +1,3 @@ -/* nanokernel thread support */ - /* * Copyright (c) 2010-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Nanokernel thread support + * * This module provides general purpose thread support, with applies to both * tasks or fibers. */ diff --git a/kernel/nanokernel/nano_init.c b/kernel/nanokernel/nano_init.c index 0ceba8dd103..52c3726d732 100644 --- a/kernel/nanokernel/nano_init.c +++ b/kernel/nanokernel/nano_init.c @@ -1,5 +1,3 @@ -/* nanokernel initialization module */ - /* * Copyright (c) 2010-2014 Wind River Systems, Inc. * @@ -16,8 +14,10 @@ * limitations under the License. */ -/* - * DESCRIPTION +/** + * @file + * @brief Nanokernel initialization module + * * This module contains routines that are used to initialize the nanokernel. */ diff --git a/scripts/gen_offset_header/gen_offset_header.c b/scripts/gen_offset_header/gen_offset_header.c index c07087bd108..fee61888487 100644 --- a/scripts/gen_offset_header/gen_offset_header.c +++ b/scripts/gen_offset_header/gen_offset_header.c @@ -14,7 +14,7 @@ * limitations under the License. */ -/* +/** * @file * @brief generate offset definition header file *