STM32 H文件注释规范实例

/**
******************************************************************************
* @file    stm32f10x_can.h
* @author  MCD Application Team
* @version V3.5.0
* @date    11-March-2011
* @brief   This file contains all the functions prototypes for the CAN firmware
*          library.
******************************************************************************
* @attention
*
* THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
* WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
* TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
* DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
* FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
* CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
*
* <h2><center>© COPYRIGHT 2011 STMicroelectronics</center></h2>
******************************************************************************
*/

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __STM32F10x_CAN_H
#define __STM32F10x_CAN_H

#ifdef __cplusplus
extern "C" {
#endif

/* Includes ------------------------------------------------------------------*/
#include "stm32f10x.h"

/** @addtogroup STM32F10x_StdPeriph_Driver
* @{
*/

/** @addtogroup CAN
* @{
*/

/** @defgroup CAN_Exported_Types
* @{
*/

#define IS_CAN_ALL_PERIPH(PERIPH) (((PERIPH) == CAN1) || \
((PERIPH) == CAN2))

/**
* @brief  CAN init structure definition
*/

typedef struct
{
uint16_t CAN_Prescaler;   /*!< Specifies the length of a time quantum.
It ranges from 1 to 1024. */
} CAN_InitTypeDef;

/**
* @}
*/

/** @defgroup CAN_Exported_Constants
* @{
*/

/** @defgroup CAN_sleep_constants
* @{
*/
#define CAN_InitStatus_Failed              ((uint8_t)0x00) /*!< CAN initialization failed */
#define CAN_InitStatus_Success             ((uint8_t)0x01) /*!< CAN initialization OK */
/**
* @}
*/

/**
* @}
*/

/** @defgroup CAN_Exported_Macros
* @{
*/

/**
* @}
*/

/** @defgroup CAN_Exported_Functions
* @{
*/
/*  Function used to set the CAN configuration to the default reset state *****/
void CAN_DeInit(CAN_TypeDef* CANx);

/* Initialization and Configuration functions *********************************/
uint8_t CAN_Init(CAN_TypeDef* CANx, CAN_InitTypeDef* CAN_InitStruct);

#ifdef __cplusplus
}
#endif

#endif /* __STM32F10x_CAN_H */
/**
* @}
*/

/**
* @}
*/

/**
* @}
*/

/******************* (C) COPYRIGHT 2011 STMicroelectronics *****END OF FILE****/