STM32 C文件注释规范实例

/**  ******************************************************************************  * @file    stm32f10x_can.c  * @author  MCD Application Team  * @version V3.5.0  * @date    11-March-2011  * @brief   This file provides all the CAN firmware functions.  ******************************************************************************  * @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>&copy; COPYRIGHT 2011 STMicroelectronics</center></h2>  ******************************************************************************  *//* Includes ------------------------------------------------------------------*/#include "stm32f10x_can.h"#include "stm32f10x_rcc.h"/** @addtogroup STM32F10x_StdPeriph_Driver  * @{  *//** @defgroup CAN   * @brief CAN driver modules  * @{  */ /** @defgroup CAN_Private_TypesDefinitions  * @{  *//**  * @}  *//** @defgroup CAN_Private_Defines  * @{  *//* CAN Master Control Register bits */#define MCR_DBF      ((uint32_t)0x00010000) /* software master reset *//* CAN Mailbox Transmit Request */#define TMIDxR_TXRQ  ((uint32_t)0x00000001) /* Transmit mailbox request *//**  * @}  *//** @defgroup CAN_Private_Macros  * @{  *//**  * @}  *//** @defgroup CAN_Private_Variables  * @{  *//**  * @}  *//** @defgroup CAN_Private_FunctionPrototypes  * @{  */static ITStatus CheckITStatus(uint32_t CAN_Reg, uint32_t It_Bit);/**  * @}  *//** @defgroup CAN_Private_Functions  * @{  *//**  * @brief   Select the CAN Operation mode.  * @param CAN_OperatingMode : CAN Operating Mode. This parameter can be one   *                            of @ref CAN_OperatingMode_TypeDef enumeration.  * @retval status of the requested mode which can be   *         - CAN_ModeStatus_Failed    CAN failed entering the specific mode   *         - CAN_ModeStatus_Success   CAN Succeed entering the specific mode   */uint8_t CAN_OperatingModeRequest(CAN_TypeDef* CANx, uint8_t CAN_OperatingMode){  uint8_t status = CAN_ModeStatus_Failed;    /* Timeout for INAK or also for SLAK bits*/  uint32_t timeout = INAK_TIMEOUT;   /* Check the parameters */  assert_param(IS_CAN_ALL_PERIPH(CANx));  if (CAN_OperatingMode == CAN_OperatingMode_Initialization)  {    /* Request initialisation */    CANx->MCR = (uint32_t)((CANx->MCR & (uint32_t)(~(uint32_t)CAN_MCR_SLEEP)) | CAN_MCR_INRQ);  }  return  (uint8_t) status;}/**  * @}  *//**  * @}  *//**  * @}  *//******************* (C) COPYRIGHT 2011 STMicroelectronics *****END OF FILE****/