Standardize the width of all comment boxes in header files

This commit is contained in:
Gregory Nutt 2015-10-02 17:47:23 -06:00
parent 36726b1bc4
commit cae0c9a2e3
16 changed files with 129 additions and 129 deletions

View File

@ -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 <nuttx/irq.h>"

View File

@ -73,9 +73,9 @@ extern "C"
#define EXTERN extern
#endif
/***************************************************************************
/****************************************************************************
* Public Function Prototypes
***************************************************************************/
****************************************************************************/
#undef EXTERN
#if defined(__cplusplus)

View File

@ -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);

View File

@ -180,8 +180,8 @@
* divider index */
/**********************************************************************************************
* Public Types**********************
************************************************************************/
* Public Types
**********************************************************************************************/
#ifndef __ASSEMBLY__
#ifdef __cplusplus

View File

@ -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 <nuttx/config.h>
/**************************************************************************
/****************************************************************************
* Pre-processor Definitions
**************************************************************************/
****************************************************************************/
/* Configuration **********************************************************/

View File

@ -83,9 +83,9 @@ extern "C"
#define EXTERN extern
#endif
/***************************************************************************
/****************************************************************************
* Public Function Prototypes
***************************************************************************/
****************************************************************************/
/****************************************************************************
* Name: sam_irq_srctype

View File

@ -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

View File

@ -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)

View File

@ -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 */

View File

@ -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"

View File

@ -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"

View File

@ -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)

View File

@ -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 */

View File

@ -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 <nuttx/config.h>
#include <nuttx/compiler.h>
@ -51,9 +51,9 @@
# include <arch/irq.h>
#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 **********************************************************/

View File

@ -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 */

View File

@ -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 */