Standardize the width of all comment boxes in C header files

This commit is contained in:
Gregory Nutt 2015-10-03 07:41:15 -06:00
parent f696caa6f4
commit 2b88bc7119
12 changed files with 83 additions and 83 deletions

View File

@ -326,7 +326,7 @@ void sam_sram_initialize(void);
* Description: * Description:
* Initialize the SPI-based SD card. * Initialize the SPI-based SD card.
* *
*****************************************************************************/ ****************************************************************************/
#if defined(CONFIG_ARDUINO_ITHEAD_TFT) && defined(CONFIG_SPI_BITBANG) && \ #if defined(CONFIG_ARDUINO_ITHEAD_TFT) && defined(CONFIG_SPI_BITBANG) && \
defined(CONFIG_MMCSD_SPI) defined(CONFIG_MMCSD_SPI)

View File

@ -315,7 +315,7 @@ extern "C" {
EXTERN void lpc43_boardinitialize(void); EXTERN void lpc43_boardinitialize(void);
/***************************************************************************** /****************************************************************************
* Name: lpc43_ledinit, lpc43_setled, and lpc43_setleds * Name: lpc43_ledinit, lpc43_setled, and lpc43_setleds
* *
* Description: * Description:

View File

@ -320,7 +320,7 @@ extern "C" {
EXTERN void lpc43_boardinitialize(void); EXTERN void lpc43_boardinitialize(void);
/***************************************************************************** /****************************************************************************
* Name: lpc43_ledinit, lpc43_setled, and lpc43_setleds * Name: lpc43_ledinit, lpc43_setled, and lpc43_setleds
* *
* Description: * Description:

View File

@ -304,7 +304,7 @@ extern "C" {
EXTERN void lpc43_boardinitialize(void); EXTERN void lpc43_boardinitialize(void);
/***************************************************************************** /****************************************************************************
* Name: lpc43_ledinit, lpc43_setled, and lpc43_setleds * Name: lpc43_ledinit, lpc43_setled, and lpc43_setleds
* *
* Description: * Description:

View File

@ -1,4 +1,4 @@
/****************************************************************************** /****************************************************************************
* configs/olimex-stm32-h405/src/olimex-stm32-h405.h * configs/olimex-stm32-h405/src/olimex-stm32-h405.h
* *
* Copyright (C) 2014 Max Holtzberg. All rights reserved. * Copyright (C) 2014 Max Holtzberg. All rights reserved.
@ -31,22 +31,22 @@
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE. * POSSIBILITY OF SUCH DAMAGE.
* *
******************************************************************************/ ****************************************************************************/
#ifndef __CONFIGS_OLIMEX_STM32_H405_SRC_INTERNAL_H #ifndef __CONFIGS_OLIMEX_STM32_H405_SRC_INTERNAL_H
#define __CONFIGS_OLIMEX_STM32_H405_SRC_INTERNAL_H #define __CONFIGS_OLIMEX_STM32_H405_SRC_INTERNAL_H
/****************************************************************************** /****************************************************************************
* Included Files * Included Files
******************************************************************************/ ****************************************************************************/
#include <nuttx/config.h> #include <nuttx/config.h>
#include <nuttx/compiler.h> #include <nuttx/compiler.h>
#include <stdint.h> #include <stdint.h>
/****************************************************************************** /****************************************************************************
* Pre-processor Definitions * Pre-processor Definitions
******************************************************************************/ ****************************************************************************/
/* Olimex-STM32-P405 GPIOs ****************************************************/ /* Olimex-STM32-P405 GPIOs ****************************************************/
/* LEDs */ /* LEDs */

View File

@ -1,4 +1,4 @@
/****************************************************************************** /****************************************************************************
* configs/olimex-stm32-p107/src/p107-internal.h * configs/olimex-stm32-p107/src/p107-internal.h
* *
* Copyright (C) 2013 Max Holtzberg. All rights reserved. * Copyright (C) 2013 Max Holtzberg. All rights reserved.
@ -31,21 +31,21 @@
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE. * POSSIBILITY OF SUCH DAMAGE.
* *
******************************************************************************/ ****************************************************************************/
#ifndef __CONFIGS_OLIMEX_STM32_P107_SRC_INTERNAL_H #ifndef __CONFIGS_OLIMEX_STM32_P107_SRC_INTERNAL_H
#define __CONFIGS_OLIMEX_STM32_P107_SRC_INTERNAL_H #define __CONFIGS_OLIMEX_STM32_P107_SRC_INTERNAL_H
/****************************************************************************** /****************************************************************************
* Included Files * Included Files
******************************************************************************/ ****************************************************************************/
#include <nuttx/config.h> #include <nuttx/config.h>
#include <nuttx/compiler.h> #include <nuttx/compiler.h>
#include <stdint.h> #include <stdint.h>
/****************************************************************************** /****************************************************************************
* Pre-processor Definitions * Pre-processor Definitions
******************************************************************************/ ****************************************************************************/
/* Olimex MOD-ENC624J600 Module /* Olimex MOD-ENC624J600 Module
* *

View File

@ -1,4 +1,4 @@
/****************************************************************************** /****************************************************************************
* configs/olimex-stm32-p107/src/olimex-stm32-p207.h * configs/olimex-stm32-p107/src/olimex-stm32-p207.h
* *
* Copyright (C) 2013 Max Holtzberg. All rights reserved. * Copyright (C) 2013 Max Holtzberg. All rights reserved.
@ -31,22 +31,22 @@
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE. * POSSIBILITY OF SUCH DAMAGE.
* *
******************************************************************************/ ****************************************************************************/
#ifndef __CONFIGS_OLIMEX_STM32_P207_SRC_INTERNAL_H #ifndef __CONFIGS_OLIMEX_STM32_P207_SRC_INTERNAL_H
#define __CONFIGS_OLIMEX_STM32_P207_SRC_INTERNAL_H #define __CONFIGS_OLIMEX_STM32_P207_SRC_INTERNAL_H
/****************************************************************************** /****************************************************************************
* Included Files * Included Files
******************************************************************************/ ****************************************************************************/
#include <nuttx/config.h> #include <nuttx/config.h>
#include <nuttx/compiler.h> #include <nuttx/compiler.h>
#include <stdint.h> #include <stdint.h>
/****************************************************************************** /****************************************************************************
* Pre-processor Definitions * Pre-processor Definitions
******************************************************************************/ ****************************************************************************/
/* Olimex-STM32-P207 GPIOs ****************************************************/ /* Olimex-STM32-P207 GPIOs ****************************************************/
/* LEDs */ /* LEDs */

View File

@ -279,9 +279,9 @@
#define ILI9341_YRES BOARD_LTDC_HEIGHT #define ILI9341_YRES BOARD_LTDC_HEIGHT
#endif /* CONFIG_STM32F429I_DISCO_ILI9341_FBIFACE */ #endif /* CONFIG_STM32F429I_DISCO_ILI9341_FBIFACE */
/**************************************************************************** /************************************************************************************
* Private Data * Private Data
****************************************************************************/ ************************************************************************************/
#ifdef CONFIG_STM32F429I_DISCO_ILI9341_LCDIFACE #ifdef CONFIG_STM32F429I_DISCO_ILI9341_LCDIFACE
FAR struct lcd_dev_s *g_lcd = NULL; FAR struct lcd_dev_s *g_lcd = NULL;
@ -296,13 +296,13 @@ FAR struct ili9341_lcd_s *g_ltdc = NULL;
************************************************************************************/ ************************************************************************************/
#ifdef CONFIG_STM32F429I_DISCO_ILI9341_FBIFACE #ifdef CONFIG_STM32F429I_DISCO_ILI9341_FBIFACE
/**************************************************************************** /************************************************************************************
* Name: stm32_ili9341_initialize * Name: stm32_ili9341_initialize
* *
* Description: * Description:
* Initialize the ili9341 LCD controller to the RGB interface mode. * Initialize the ili9341 LCD controller to the RGB interface mode.
* *
****************************************************************************/ ************************************************************************************/
static int stm32_ili9341_initialize(void) static int stm32_ili9341_initialize(void)
{ {
@ -413,7 +413,7 @@ static int stm32_ili9341_initialize(void)
************************************************************************************/ ************************************************************************************/
#ifdef CONFIG_STM32F429I_DISCO_ILI9341_LCDIFACE #ifdef CONFIG_STM32F429I_DISCO_ILI9341_LCDIFACE
/**************************************************************************** /************************************************************************************
* Name: board_lcd_uninitialize * Name: board_lcd_uninitialize
* *
* Description: * Description:
@ -423,7 +423,7 @@ static int stm32_ili9341_initialize(void)
* *
* Return: * Return:
* *
****************************************************************************/ ************************************************************************************/
void board_lcd_uninitialize(void) void board_lcd_uninitialize(void)
{ {
@ -435,7 +435,7 @@ void board_lcd_uninitialize(void)
} }
/**************************************************************************** /************************************************************************************
* Name: board_lcd_getdev * Name: board_lcd_getdev
* *
* Description: * Description:
@ -448,7 +448,7 @@ void board_lcd_uninitialize(void)
* Return: * Return:
* Reference to the LCD object if exist otherwise NULL * Reference to the LCD object if exist otherwise NULL
* *
****************************************************************************/ ************************************************************************************/
FAR struct lcd_dev_s *board_lcd_getdev(int lcddev) FAR struct lcd_dev_s *board_lcd_getdev(int lcddev)
{ {
@ -461,7 +461,7 @@ FAR struct lcd_dev_s *board_lcd_getdev(int lcddev)
} }
/**************************************************************************** /************************************************************************************
* Name: board_lcd_initialize * Name: board_lcd_initialize
* *
* Description: * Description:
@ -475,7 +475,7 @@ FAR struct lcd_dev_s *board_lcd_getdev(int lcddev)
* On success - Ok * On success - Ok
* On error - Error Code * On error - Error Code
* *
****************************************************************************/ ************************************************************************************/
int board_lcd_initialize(void) int board_lcd_initialize(void)
{ {
@ -512,7 +512,7 @@ int board_lcd_initialize(void)
#endif /* CONFIG_STM32F429I_DISCO_ILI9341_LCDIFACE */ #endif /* CONFIG_STM32F429I_DISCO_ILI9341_LCDIFACE */
#ifdef CONFIG_STM32_LTDC #ifdef CONFIG_STM32_LTDC
/**************************************************************************** /************************************************************************************
* Name: up_fbinitialize * Name: up_fbinitialize
* *
* Description: * Description:
@ -521,7 +521,7 @@ int board_lcd_initialize(void)
* Return: * Return:
* OK - On succes * OK - On succes
* *
****************************************************************************/ ************************************************************************************/
int up_fbinitialize(void) int up_fbinitialize(void)
{ {
@ -546,7 +546,7 @@ int up_fbinitialize(void)
#endif #endif
} }
/**************************************************************************** /************************************************************************************
* Name: up_fbgetvplane * Name: up_fbgetvplane
* *
* Description: * Description:
@ -558,27 +558,27 @@ int up_fbinitialize(void)
* Return: * Return:
* Reference to the fb_vtable_s on success otherwise NULL. * Reference to the fb_vtable_s on success otherwise NULL.
* *
****************************************************************************/ ************************************************************************************/
FAR struct fb_vtable_s *up_fbgetvplane(int vplane) FAR struct fb_vtable_s *up_fbgetvplane(int vplane)
{ {
return stm32_ltdcgetvplane(vplane); return stm32_ltdcgetvplane(vplane);
} }
/**************************************************************************** /************************************************************************************
* Name: up_uninitialize * Name: up_uninitialize
* *
* Description: * Description:
* The generic method to uninitialize the framebuffer device * The generic method to uninitialize the framebuffer device
* *
****************************************************************************/ ************************************************************************************/
void fb_uninitialize(void) void fb_uninitialize(void)
{ {
stm32_ltdcuninitialize(); stm32_ltdcuninitialize();
} }
/**************************************************************************** /************************************************************************************
* Name: up_ltdcgetlayer * Name: up_ltdcgetlayer
* *
* Description: * Description:
@ -588,7 +588,7 @@ void fb_uninitialize(void)
* Parameter: * Parameter:
* lid - The specific layer identifier * lid - The specific layer identifier
* *
****************************************************************************/ ************************************************************************************/
#ifdef CONFIG_STM32_LTDC_INTERFACE #ifdef CONFIG_STM32_LTDC_INTERFACE
FAR struct ltdc_layer_s *up_ltdcgetlayer(int lid) FAR struct ltdc_layer_s *up_ltdcgetlayer(int lid)

View File

@ -234,13 +234,13 @@ void stm32_pmbuttons(void);
* for the specified ILI9341 LCD Single chip driver connected as 4 wire serial * for the specified ILI9341 LCD Single chip driver connected as 4 wire serial
* (spi). NULL is returned on any failure. * (spi). NULL is returned on any failure.
* *
******************************************************************************/ ****************************************************************************/
FAR struct ili9341_lcd_s *stm32_ili93414ws_initialize(void); FAR struct ili9341_lcd_s *stm32_ili93414ws_initialize(void);
#endif #endif
#ifdef CONFIG_STM32_SPI5 #ifdef CONFIG_STM32_SPI5
/****************************************************************************** /****************************************************************************
* Name: stm32_spi5initialize * Name: stm32_spi5initialize
* *
* Description: * Description:
@ -259,7 +259,7 @@ FAR struct ili9341_lcd_s *stm32_ili93414ws_initialize(void);
* Returned Value: * Returned Value:
* Valid SPI device structure reference on succcess; a NULL on failure * Valid SPI device structure reference on succcess; a NULL on failure
* *
******************************************************************************/ ****************************************************************************/
FAR struct spi_dev_s *stm32_spi5initialize(void); FAR struct spi_dev_s *stm32_spi5initialize(void);
#endif #endif

View File

@ -37,9 +37,9 @@
#ifndef __CONFIGS_STM32VL_DISCOVERY_SRC_STM32VLDISCOVERY_H #ifndef __CONFIGS_STM32VL_DISCOVERY_SRC_STM32VLDISCOVERY_H
#define __CONFIGS_STM32VL_DISCOVERY_SRC_STM32VLDISCOVERY_H #define __CONFIGS_STM32VL_DISCOVERY_SRC_STM32VLDISCOVERY_H
/***************************************************************************** /****************************************************************************
* Pre-processor Definitions * Pre-processor Definitions
*****************************************************************************/ ****************************************************************************/
/* LED - assume it is on PC8 */ /* LED - assume it is on PC8 */

View File

@ -1,4 +1,4 @@
/***************************************************************************** /****************************************************************************
* configs/teensy-lc/src/teensy-lc.h * configs/teensy-lc/src/teensy-lc.h
* *
* Copyright (C) 2015 Gregory Nutt. All rights reserved. * Copyright (C) 2015 Gregory Nutt. All rights reserved.
@ -31,61 +31,61 @@
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE. * POSSIBILITY OF SUCH DAMAGE.
* *
*****************************************************************************/ ****************************************************************************/
#ifndef __CONFIGS_TEENSY_LC_SRC_TEENSY_LC_H #ifndef __CONFIGS_TEENSY_LC_SRC_TEENSY_LC_H
#define __CONFIGS_TEENSY_LC_SRC_TEENSY_LC_H #define __CONFIGS_TEENSY_LC_SRC_TEENSY_LC_H
/***************************************************************************** /****************************************************************************
* Included Files * Included Files
*****************************************************************************/ ****************************************************************************/
#include <nuttx/config.h> #include <nuttx/config.h>
#include <nuttx/compiler.h> #include <nuttx/compiler.h>
#include <stdint.h> #include <stdint.h>
/***************************************************************************** /****************************************************************************
* Pre-processor Definitions * Pre-processor Definitions
*****************************************************************************/ ****************************************************************************/
/* Configuration *************************************************************/ /* Configuration ************************************************************/
#define GPIO_LED (GPIO_OUTPUT | GPIO_OUTPUT_ONE | PIN_PORTC | PIN5) #define GPIO_LED (GPIO_OUTPUT | GPIO_OUTPUT_ONE | PIN_PORTC | PIN5)
/* Button definitions ********************************************************/ /* Button definitions *******************************************************/
/* Chip selects **************************************************************/ /* Chip selects *************************************************************/
/***************************************************************************** /****************************************************************************
* Public Types * Public Types
*****************************************************************************/ ****************************************************************************/
/***************************************************************************** /****************************************************************************
* Public data * Public data
*****************************************************************************/ ****************************************************************************/
#ifndef __ASSEMBLY__ #ifndef __ASSEMBLY__
/***************************************************************************** /****************************************************************************
* Public Functions * Public Functions
*****************************************************************************/ ****************************************************************************/
/***************************************************************************** /****************************************************************************
* Name: kl_spiinitialize * Name: kl_spiinitialize
* *
* Description: * Description:
* Called to configure SPI chip select GPIO pins for the Freedom KL25Z board. * Called to configure SPI chip select GPIO pins for the Freedom KL25Z board.
* *
*****************************************************************************/ ****************************************************************************/
void weak_function kl_spiinitialize(void); void weak_function kl_spiinitialize(void);
/***************************************************************************** /****************************************************************************
* Name: kl_ledinit * Name: kl_ledinit
* *
* Description: * Description:
* Initialize the on-board LED * Initialize the on-board LED
* *
*****************************************************************************/ ****************************************************************************/
#ifdef CONFIG_ARCH_LEDS #ifdef CONFIG_ARCH_LEDS
void kl_ledinit(void); void kl_ledinit(void);

View File

@ -1,4 +1,4 @@
/****************************************************************************** /****************************************************************************
* configs/viewtool-stm32f107/src/viewtool_stm32f107.h * configs/viewtool-stm32f107/src/viewtool_stm32f107.h
* *
* Copyright (C) 2013-2014 Gregory Nutt. All rights reserved. * Copyright (C) 2013-2014 Gregory Nutt. All rights reserved.
@ -31,23 +31,23 @@
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE. * POSSIBILITY OF SUCH DAMAGE.
* *
******************************************************************************/ ****************************************************************************/
#ifndef __CONFIGS_VIEWTOOL_STM32F107_SRC_INTERNAL_H #ifndef __CONFIGS_VIEWTOOL_STM32F107_SRC_INTERNAL_H
#define __CONFIGS_VIEWTOOL_STM32F107_SRC_INTERNAL_H #define __CONFIGS_VIEWTOOL_STM32F107_SRC_INTERNAL_H
/****************************************************************************** /****************************************************************************
* Included Files * Included Files
******************************************************************************/ ****************************************************************************/
#include <nuttx/config.h> #include <nuttx/config.h>
#include <nuttx/compiler.h> #include <nuttx/compiler.h>
#include <stdint.h> #include <stdint.h>
/****************************************************************************** /****************************************************************************
* Pre-processor Definitions * Pre-processor Definitions
******************************************************************************/ ****************************************************************************/
/* Configuration **************************************************************/ /* Configuration ************************************************************/
/* Assume that everything is supported */ /* Assume that everything is supported */
#define HAVE_USBDEV 1 #define HAVE_USBDEV 1
@ -91,7 +91,7 @@
#define VIEWTOOL_MMCSD_SLOTNO 0 #define VIEWTOOL_MMCSD_SLOTNO 0
/* GPIO Configuration *********************************************************/ /* GPIO Configuration *******************************************************/
/* LEDs /* LEDs
* *
* There are four LEDs on the ViewTool STM32F103/F107 board that can be controlled * There are four LEDs on the ViewTool STM32F103/F107 board that can be controlled
@ -114,7 +114,7 @@
GPIO_OUTPUT_SET | GPIO_PORTB | GPIO_PIN13) GPIO_OUTPUT_SET | GPIO_PORTB | GPIO_PIN13)
/* Buttons **************************************************************************/ /* Buttons ******************************************************************/
/* All pulled high and will be sensed low when depressed. /* All pulled high and will be sensed low when depressed.
* *
* SW2 PC11 Needs J42 closed * SW2 PC11 Needs J42 closed
@ -285,19 +285,19 @@
#define GPIO_MPL115A_CS (GPIO_OUTPUT | GPIO_CNF_OUTPP | GPIO_MODE_50MHz | \ #define GPIO_MPL115A_CS (GPIO_OUTPUT | GPIO_CNF_OUTPP | GPIO_MODE_50MHz | \
GPIO_OUTPUT_SET | GPIO_PORTB | GPIO_PIN6) GPIO_OUTPUT_SET | GPIO_PORTB | GPIO_PIN6)
/************************************************************************************ /****************************************************************************
* Public Functions * Public Functions
************************************************************************************/ ****************************************************************************/
#ifndef __ASSEMBLY__ #ifndef __ASSEMBLY__
/************************************************************************************ /****************************************************************************
* Name: stm32_spiinitialize * Name: stm32_spiinitialize
* *
* Description: * Description:
* Called to configure SPI chip select GPIO pins for the M3 Wildfire board. * Called to configure SPI chip select GPIO pins for the M3 Wildfire board.
* *
************************************************************************************/ ****************************************************************************/
void weak_function stm32_spiinitialize(void); void weak_function stm32_spiinitialize(void);
@ -311,31 +311,31 @@ void weak_function stm32_spiinitialize(void);
void stm32_ledinit(void); void stm32_ledinit(void);
/************************************************************************************ /****************************************************************************
* Name: stm32_usbdev_initialize * Name: stm32_usbdev_initialize
* *
* Description: * Description:
* Called from stm32_usbdev_initialize very early in initialization to setup USB-related * Called from stm32_usbdev_initialize very early in initialization to setup USB-related
* GPIO pins for the Viewtool STM32F107 board. * GPIO pins for the Viewtool STM32F107 board.
* *
************************************************************************************/ ****************************************************************************/
#if defined(CONFIG_STM32_OTGFS) && defined(CONFIG_USBDEV) #if defined(CONFIG_STM32_OTGFS) && defined(CONFIG_USBDEV)
void weak_function stm32_usbdev_initialize(void); void weak_function stm32_usbdev_initialize(void);
#endif #endif
/************************************************************************************ /****************************************************************************
* Name: stm32_sdinitialize * Name: stm32_sdinitialize
* *
* Description: * Description:
* Initialize the SPI-based SD card. Requires CONFIG_DISABLE_MOUNTPOINT=n * Initialize the SPI-based SD card. Requires CONFIG_DISABLE_MOUNTPOINT=n
* and CONFIG_STM32_SPI1=y * and CONFIG_STM32_SPI1=y
* *
************************************************************************************/ ****************************************************************************/
int stm32_sdinitialize(int minor); int stm32_sdinitialize(int minor);
/************************************************************************************ /****************************************************************************
* Name: stm32_mpl115ainitialize * Name: stm32_mpl115ainitialize
* *
* Description: * Description:
@ -347,7 +347,7 @@ int stm32_sdinitialize(int minor);
* Returned Value: * Returned Value:
* Zero (OK) on success; a negated errno value on failure. * Zero (OK) on success; a negated errno value on failure.
* *
************************************************************************************/ ****************************************************************************/
#if defined(CONFIG_SPI) && defined(CONFIG_MPL115A) && defined(CONFIG_STM32_SPI3) #if defined(CONFIG_SPI) && defined(CONFIG_MPL115A) && defined(CONFIG_STM32_SPI3)
int stm32_mpl115ainitialize(FAR const char *devpath); int stm32_mpl115ainitialize(FAR const char *devpath);