From cae0c9a2e33034f78fa197ad8b9f989de4e7599a Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Fri, 2 Oct 2015 17:47:23 -0600 Subject: [PATCH] Standardize the width of all comment boxes in header files --- arch/arm/include/calypso/irq.h | 2 +- arch/arm/src/a1x/a1x_irq.h | 4 +-- arch/arm/src/armv7-a/l2cc.h | 40 ++++++++++++++-------------- arch/arm/src/lpc31xx/lpc31_cgudrvr.h | 4 +-- arch/arm/src/sama5/sam_config.h | 12 ++++----- arch/arm/src/sama5/sam_irq.h | 4 +-- arch/arm/src/samv7/sam_mcan.h | 8 +++--- arch/rgmp/include/limits.h | 12 ++++----- arch/rgmp/include/types.h | 20 +++++++------- arch/sim/include/arch.h | 28 +++++++++---------- arch/sim/include/irq.h | 28 +++++++++---------- arch/sim/include/limits.h | 12 ++++----- arch/sim/include/types.h | 20 +++++++------- arch/sim/src/up_internal.h | 24 ++++++++--------- arch/x86/include/i486/types.h | 20 +++++++------- arch/z16/include/serial.h | 20 +++++++------- 16 files changed, 129 insertions(+), 129 deletions(-) diff --git a/arch/arm/include/calypso/irq.h b/arch/arm/include/calypso/irq.h index fd579c4d32..baea3de5a3 100644 --- a/arch/arm/include/calypso/irq.h +++ b/arch/arm/include/calypso/irq.h @@ -35,7 +35,7 @@ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - **************************************************************************/ + ****************************************************************************/ #ifndef __INCLUDE_NUTTX_IRQ_H #error "This file should never be included directly! Use " diff --git a/arch/arm/src/a1x/a1x_irq.h b/arch/arm/src/a1x/a1x_irq.h index 15d236d0c4..ad0925707c 100644 --- a/arch/arm/src/a1x/a1x_irq.h +++ b/arch/arm/src/a1x/a1x_irq.h @@ -73,9 +73,9 @@ extern "C" #define EXTERN extern #endif -/*************************************************************************** +/**************************************************************************** * Public Function Prototypes - ***************************************************************************/ + ****************************************************************************/ #undef EXTERN #if defined(__cplusplus) diff --git a/arch/arm/src/armv7-a/l2cc.h b/arch/arm/src/armv7-a/l2cc.h index 7dab637653..1c09f81fd6 100644 --- a/arch/arm/src/armv7-a/l2cc.h +++ b/arch/arm/src/armv7-a/l2cc.h @@ -66,7 +66,7 @@ extern "C" * Public Function Prototypes ****************************************************************************/ -/*************************************************************************** +/**************************************************************************** * Name: up_l2ccinitialize * * Description: @@ -80,13 +80,13 @@ extern "C" * Returned Value: * None * - ***************************************************************************/ + ****************************************************************************/ #if 0 /* Prototyped in up_internal.h */ void up_l2ccinitialize(void); #endif -/*************************************************************************** +/**************************************************************************** * Name: l2cc_enable * * Description: @@ -99,11 +99,11 @@ void up_l2ccinitialize(void); * Returned Value: * None * - ***************************************************************************/ + ****************************************************************************/ void l2cc_enable(void); -/*************************************************************************** +/**************************************************************************** * Name: l2cc_disable * * Description: @@ -115,11 +115,11 @@ void l2cc_enable(void); * Returned Value: * None * - ***************************************************************************/ + ****************************************************************************/ void l2cc_disable(void); -/*************************************************************************** +/**************************************************************************** * Name: l2cc_sync * * Description: @@ -131,11 +131,11 @@ void l2cc_disable(void); * Returned Value: * None * - ***************************************************************************/ + ****************************************************************************/ void l2cc_sync(void); -/*************************************************************************** +/**************************************************************************** * Name: l2cc_invalidate_all * * Description: @@ -147,11 +147,11 @@ void l2cc_sync(void); * Returned Value: * None * - ***************************************************************************/ + ****************************************************************************/ void l2cc_invalidate_all(void); -/*************************************************************************** +/**************************************************************************** * Name: l2cc_invalidate * * Description: @@ -164,11 +164,11 @@ void l2cc_invalidate_all(void); * Returned Value: * None * - ***************************************************************************/ + ****************************************************************************/ void l2cc_invalidate(uintptr_t startaddr, uintptr_t endaddr); -/*************************************************************************** +/**************************************************************************** * Name: l2cc_clean_all * * Description: @@ -180,11 +180,11 @@ void l2cc_invalidate(uintptr_t startaddr, uintptr_t endaddr); * Returned Value: * None * - ***************************************************************************/ + ****************************************************************************/ void l2cc_clean_all(void); -/*************************************************************************** +/**************************************************************************** * Name: l2cc_clean * * Description: @@ -197,11 +197,11 @@ void l2cc_clean_all(void); * Returned Value: * None * - ***************************************************************************/ + ****************************************************************************/ void l2cc_clean(uintptr_t startaddr, uintptr_t endaddr); -/*************************************************************************** +/**************************************************************************** * Name: l2cc_flush_all * * Description: @@ -213,11 +213,11 @@ void l2cc_clean(uintptr_t startaddr, uintptr_t endaddr); * Returned Value: * None * - ***************************************************************************/ + ****************************************************************************/ void l2cc_flush_all(void); -/*************************************************************************** +/**************************************************************************** * Name: l2cc_flush * * Description: @@ -230,7 +230,7 @@ void l2cc_flush_all(void); * Returned Value: * None * - ***************************************************************************/ + ****************************************************************************/ void l2cc_flush(uint32_t startaddr, uint32_t endaddr); diff --git a/arch/arm/src/lpc31xx/lpc31_cgudrvr.h b/arch/arm/src/lpc31xx/lpc31_cgudrvr.h index f2c12528d4..47a2e3917f 100644 --- a/arch/arm/src/lpc31xx/lpc31_cgudrvr.h +++ b/arch/arm/src/lpc31xx/lpc31_cgudrvr.h @@ -180,8 +180,8 @@ * divider index */ /********************************************************************************************** - * Public Types********************** - ************************************************************************/ + * Public Types + **********************************************************************************************/ #ifndef __ASSEMBLY__ #ifdef __cplusplus diff --git a/arch/arm/src/sama5/sam_config.h b/arch/arm/src/sama5/sam_config.h index af8ea87667..650d6c1503 100644 --- a/arch/arm/src/sama5/sam_config.h +++ b/arch/arm/src/sama5/sam_config.h @@ -1,4 +1,4 @@ -/************************************************************************** +/**************************************************************************** * arch/arm/src/sama5/sam_config.h * * Copyright (C) 2015 Gregory Nutt. All rights reserved. @@ -31,20 +31,20 @@ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - **************************************************************************/ + ****************************************************************************/ #ifndef __ARCH_ARM_SRC_SAMA5_SAM_CONFIG_H #define __ARCH_ARM_SRC_SAMA5_SAM_CONFIG_H 1 -/************************************************************************** +/**************************************************************************** * Included Files - **************************************************************************/ + ****************************************************************************/ #include -/************************************************************************** +/**************************************************************************** * Pre-processor Definitions - **************************************************************************/ + ****************************************************************************/ /* Configuration **********************************************************/ diff --git a/arch/arm/src/sama5/sam_irq.h b/arch/arm/src/sama5/sam_irq.h index 505aa69034..5f462862d0 100644 --- a/arch/arm/src/sama5/sam_irq.h +++ b/arch/arm/src/sama5/sam_irq.h @@ -83,9 +83,9 @@ extern "C" #define EXTERN extern #endif -/*************************************************************************** +/**************************************************************************** * Public Function Prototypes - ***************************************************************************/ + ****************************************************************************/ /**************************************************************************** * Name: sam_irq_srctype diff --git a/arch/arm/src/samv7/sam_mcan.h b/arch/arm/src/samv7/sam_mcan.h index 741c458a78..540800b37d 100644 --- a/arch/arm/src/samv7/sam_mcan.h +++ b/arch/arm/src/samv7/sam_mcan.h @@ -59,9 +59,9 @@ #define MCAN0 0 #define MCAN1 1 -/*************************************************************************** +/**************************************************************************** * Public Types - ***************************************************************************/ + ****************************************************************************/ #ifndef __ASSEMBLY__ @@ -78,9 +78,9 @@ extern "C" #define EXTERN extern #endif -/*************************************************************************** +/**************************************************************************** * Public Functions - ***************************************************************************/ + ****************************************************************************/ /**************************************************************************** * Name: sam_mcan_initialize diff --git a/arch/rgmp/include/limits.h b/arch/rgmp/include/limits.h index 0a6a05c1a6..a17af23d99 100644 --- a/arch/rgmp/include/limits.h +++ b/arch/rgmp/include/limits.h @@ -1,4 +1,4 @@ -/************************************************************ +/**************************************************************************** * arch/rgmp/include/limits.h * * Copyright (C) 2011-2012 Gregory Nutt. All rights reserved. @@ -31,18 +31,18 @@ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - ************************************************************/ + ****************************************************************************/ #ifndef __ARCH_RGMP_INCLUDE_LIMITS_H #define __ARCH_RGMP_INCLUDE_LIMITS_H -/************************************************************ +/**************************************************************************** * Included Files - ************************************************************/ + ****************************************************************************/ -/************************************************************ +/**************************************************************************** * Pre-processor Definitions - ************************************************************/ + ****************************************************************************/ #define CHAR_BIT 8 #define SCHAR_MIN (-SCHAR_MAX - 1) diff --git a/arch/rgmp/include/types.h b/arch/rgmp/include/types.h index 482ae0dbd6..90865e3e08 100644 --- a/arch/rgmp/include/types.h +++ b/arch/rgmp/include/types.h @@ -1,4 +1,4 @@ -/************************************************************************ +/**************************************************************************** * arch/rgmp/include/types.h * * Copyright (C) 2011 Gregory Nutt. All rights reserved. @@ -31,7 +31,7 @@ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - ************************************************************************/ + ****************************************************************************/ /* This file should never be included directed but, rather, * only indirectly through sys/types.h @@ -40,17 +40,17 @@ #ifndef __ARCH_RGMP_INCLUDE_TYPES_H #define __ARCH_RGMP_INCLUDE_TYPES_H -/************************************************************************ +/**************************************************************************** * Included Files - ************************************************************************/ + ****************************************************************************/ -/************************************************************************ +/**************************************************************************** * Pre-processor Definitions - ************************************************************************/ + ****************************************************************************/ -/************************************************************************ +/**************************************************************************** * Type Declarations - ************************************************************************/ + ****************************************************************************/ #ifndef __ASSEMBLY__ @@ -89,8 +89,8 @@ typedef unsigned int irqstate_t; #endif /* __ASSEMBLY__ */ -/************************************************************************ +/**************************************************************************** * Public Function Prototypes - ************************************************************************/ + ****************************************************************************/ #endif /* __ARCH_RGMP_INCLUDE_TYPES_H */ diff --git a/arch/sim/include/arch.h b/arch/sim/include/arch.h index 97cfc77602..29cf6495fc 100644 --- a/arch/sim/include/arch.h +++ b/arch/sim/include/arch.h @@ -1,4 +1,4 @@ -/************************************************************ +/**************************************************************************** * arch.h * * Copyright (C) 2007 Gregory Nutt. All rights reserved. @@ -31,7 +31,7 @@ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - ************************************************************/ + ****************************************************************************/ /* This file should never be included directed but, rather, * only indirectly through nuttx/arch.h @@ -40,29 +40,29 @@ #ifndef __ARCH_ARCH_H #define __ARCH_ARCH_H -/************************************************************ +/**************************************************************************** * Included Files - ************************************************************/ + ****************************************************************************/ -/************************************************************ +/**************************************************************************** * Pre-processor Definitions - ************************************************************/ + ****************************************************************************/ -/************************************************************ +/**************************************************************************** * Inline functions - ************************************************************/ + ****************************************************************************/ -/************************************************************ +/**************************************************************************** * Public Types - ************************************************************/ + ****************************************************************************/ -/************************************************************ +/**************************************************************************** * Public Data - ************************************************************/ + ****************************************************************************/ -/************************************************************ +/**************************************************************************** * Public Function Prototypes - ************************************************************/ + ****************************************************************************/ #ifdef __cplusplus #define EXTERN extern "C" diff --git a/arch/sim/include/irq.h b/arch/sim/include/irq.h index c167ae6a6e..47bcb37826 100644 --- a/arch/sim/include/irq.h +++ b/arch/sim/include/irq.h @@ -1,4 +1,4 @@ -/************************************************************ +/**************************************************************************** * irq.h * * Copyright (C) 2007, 2009 Gregory Nutt. All rights reserved. @@ -31,7 +31,7 @@ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - ************************************************************/ + ****************************************************************************/ /* This file should never be included directed but, rather, * only indirectly through nuttx/irq.h @@ -40,13 +40,13 @@ #ifndef __ARCH_IRQ_H #define __ARCH_IRQ_H -/************************************************************ +/**************************************************************************** * Included Files - ************************************************************/ + ****************************************************************************/ -/************************************************************ +/**************************************************************************** * Pre-processor Definitions - ************************************************************/ + ****************************************************************************/ /* No interrupts */ #define NR_IRQS 0 @@ -63,9 +63,9 @@ # define XCPTCONTEXT_REGS 6 #endif -/************************************************************ +/**************************************************************************** * Public Types - ************************************************************/ + ****************************************************************************/ #ifndef __ASSEMBLY__ /* Number of registers saved in context switch */ @@ -86,9 +86,9 @@ struct xcptcontext }; #endif -/************************************************************ +/**************************************************************************** * Inline functions - ************************************************************/ + ****************************************************************************/ #ifndef __ASSEMBLY__ static inline irqstate_t irqsave(void) @@ -101,13 +101,13 @@ static inline void irqrestore(irqstate_t flags) } #endif -/************************************************************ +/**************************************************************************** * Public Data - ************************************************************/ + ****************************************************************************/ -/************************************************************ +/**************************************************************************** * Public Function Prototypes - ************************************************************/ + ****************************************************************************/ #ifdef __cplusplus #define EXTERN extern "C" diff --git a/arch/sim/include/limits.h b/arch/sim/include/limits.h index d5621b65d7..6a52c2c1b1 100644 --- a/arch/sim/include/limits.h +++ b/arch/sim/include/limits.h @@ -1,4 +1,4 @@ -/************************************************************ +/**************************************************************************** * arch/sim/include/limits.h * * Copyright (C) 2007, 2009, 2012 Gregory Nutt. All rights reserved. @@ -31,18 +31,18 @@ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - ************************************************************/ + ****************************************************************************/ #ifndef __ARCH_SIM_INCLUDE_LIMITS_H #define __ARCH_SIM_INCLUDE_LIMITS_H -/************************************************************ +/**************************************************************************** * Included Files - ************************************************************/ + ****************************************************************************/ -/************************************************************ +/**************************************************************************** * Pre-processor Definitions - ************************************************************/ + ****************************************************************************/ #define CHAR_BIT 8 #define SCHAR_MIN (-SCHAR_MAX - 1) diff --git a/arch/sim/include/types.h b/arch/sim/include/types.h index 3adf56fabd..d8f734e3fc 100644 --- a/arch/sim/include/types.h +++ b/arch/sim/include/types.h @@ -1,4 +1,4 @@ -/************************************************************************ +/**************************************************************************** * arch/sim/include/types.h * * Copyright (C) 2007, 2009, 2014 Gregory Nutt. All rights reserved. @@ -31,7 +31,7 @@ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - ************************************************************************/ + ****************************************************************************/ /* This file should never be included directed but, rather, * only indirectly through sys/types.h @@ -40,17 +40,17 @@ #ifndef __ARCH_SIM_INCLUDE_TYPES_H #define __ARCH_SIM_INCLUDE_TYPES_H -/************************************************************************ +/**************************************************************************** * Included Files - ************************************************************************/ + ****************************************************************************/ -/************************************************************************ +/**************************************************************************** * Pre-processor Definitions - ************************************************************************/ + ****************************************************************************/ -/************************************************************************ +/**************************************************************************** * Type Declarations - ************************************************************************/ + ****************************************************************************/ #ifndef __ASSEMBLY__ @@ -97,8 +97,8 @@ typedef unsigned int irqstate_t; #endif /* __ASSEMBLY__ */ -/************************************************************************ +/**************************************************************************** * Public Function Prototypes - ************************************************************************/ + ****************************************************************************/ #endif /* __ARCH_SIM_INCLUDE_TYPES_H */ diff --git a/arch/sim/src/up_internal.h b/arch/sim/src/up_internal.h index 5feb7868d0..32209c7995 100644 --- a/arch/sim/src/up_internal.h +++ b/arch/sim/src/up_internal.h @@ -1,4 +1,4 @@ -/************************************************************************** +/**************************************************************************** * arch/sim/src/up_internal.h * * Copyright (C) 2007, 2009, 2011-2012, 2014 Gregory Nutt. All rights reserved. @@ -31,14 +31,14 @@ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - **************************************************************************/ + ****************************************************************************/ #ifndef __ARCH_SIM_SRC_UP_INTERNAL_H #define __ARCH_SIM_SRC_UP_INTERNAL_H -/************************************************************************** +/**************************************************************************** * Included Files - **************************************************************************/ + ****************************************************************************/ #include #include @@ -51,9 +51,9 @@ # include #endif -/************************************************************************** +/**************************************************************************** * Pre-processor Definitions - **************************************************************************/ + ****************************************************************************/ /* Configuration **********************************************************/ #ifndef CONFIG_SIM_X11FB @@ -180,13 +180,13 @@ #define SECTORS_PER_CLUSTER 4 #define LOGICAL_SECTOR_SIZE 512 -/************************************************************************** +/**************************************************************************** * Public Types - **************************************************************************/ + ****************************************************************************/ -/************************************************************************** +/**************************************************************************** * Public Data - **************************************************************************/ + ****************************************************************************/ #ifndef __ASSEMBLY__ @@ -201,9 +201,9 @@ extern volatile int g_eventloop; extern volatile int g_uart_data_available; #endif -/************************************************************************** +/**************************************************************************** * Public Function Prototypes - **************************************************************************/ + ****************************************************************************/ /* up_setjmp32.S **********************************************************/ diff --git a/arch/x86/include/i486/types.h b/arch/x86/include/i486/types.h index c30026a221..1fde978be6 100644 --- a/arch/x86/include/i486/types.h +++ b/arch/x86/include/i486/types.h @@ -1,4 +1,4 @@ -/************************************************************************ +/**************************************************************************** * arch/x86/include/i486/types.h * * Copyright (C) 2011 Gregory Nutt. All rights reserved. @@ -31,7 +31,7 @@ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - ************************************************************************/ + ****************************************************************************/ /* This file should never be included directed but, rather, only * indirectly through arch/types.h (which is, in turn only accessed @@ -41,17 +41,17 @@ #ifndef __ARCH_X86_INCLUDE_I486_TYPES_H #define __ARCH_X86_INCLUDE_I486_TYPES_H -/************************************************************************ +/**************************************************************************** * Included Files - ************************************************************************/ + ****************************************************************************/ -/************************************************************************ +/**************************************************************************** * Pre-processor Definitions - ************************************************************************/ + ****************************************************************************/ -/************************************************************************ +/**************************************************************************** * Type Declarations - ************************************************************************/ + ****************************************************************************/ #ifndef __ASSEMBLY__ @@ -90,8 +90,8 @@ typedef unsigned int irqstate_t; #endif /* __ASSEMBLY__ */ -/************************************************************************ +/**************************************************************************** * Public Function Prototypes - ************************************************************************/ + ****************************************************************************/ #endif /* __ARCH_X86_INCLUDE_I486_TYPES_H */ diff --git a/arch/z16/include/serial.h b/arch/z16/include/serial.h index 19b9a9d668..c1ce4aa1f1 100644 --- a/arch/z16/include/serial.h +++ b/arch/z16/include/serial.h @@ -1,4 +1,4 @@ -/************************************************************ +/**************************************************************************** * arch/serial.h * * Copyright (C) 2007 Gregory Nutt. All rights reserved. @@ -31,25 +31,25 @@ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - ************************************************************/ + ****************************************************************************/ #ifndef __ARCH_SERIAL_H #define __ARCH_SERIAL_H -/************************************************************ +/**************************************************************************** * Included Files - ************************************************************/ + ****************************************************************************/ -/************************************************************ +/**************************************************************************** * Pre-processor Definitions - ************************************************************/ + ****************************************************************************/ -/************************************************************ +/**************************************************************************** * Public Data - ************************************************************/ + ****************************************************************************/ -/************************************************************ +/**************************************************************************** * Public Functions - ************************************************************/ + ****************************************************************************/ #endif /* __ARCH_SERIAL_H */