doxygen C/C++注释规范例子
官方使用手册
附CSDN下载连接:https://download.csdn.net/upload/11657370
附官网下载连接:http://www.doxygen.nl/download.html#dlmanual
变量注释规范
/*!< @brief Number of HW frame done interrupt received */
uint16_t hwFrameDoneCount;
函数注释规范
/*!
* @brief Function is executed after the HWA CFAR algorithm. It reduces the
* number of detected objects performed by CFAR algorithm. It selects only
* those objects with peaks greater than its neighbors.
*
*
* @param[in] numDetectedObjects Number of detected objects by HWA CFAR algorithm
*
* @param[in] detBuffptr Pointer to range-doppler matrix which was
* used by CFAR alogorithm to generate detected
* objects, size number of range bins times number
* of doppler bins.
*
* @param[in] cfarObjptr Pointer to the output structure generated
* by CFAR algorithm, contains list of detected objects.
*
* @param[in] fftBuffptr Pointer to 2nd D FFT buffer with complex symbols.
* The size of buffer is
* numRangeBins * numDopplerBins * (numVirtualAntAzim + numVirtualAntElev).
*
* @param[out] objOut Output pointer to the structure with with selected objects.
* The function fills range and doppler index of the object.
*
* @param[out] dstPtrAzim Output pointer (local memory of HWA) filled with antenna
* symbols of selected objects for azimuth calculation.
*
* @param[out] dstPtrElev Output pointer (local memory of HWA) filled with antenna
* symbols of selected objects for elevation calculation.
*
* @param[in] numTxAnt Number of Tx antennas
*
* @param[in] numRxAnt Number of Rx antennas
*
* @param[in] numVirtualAntAzim Number of virtual azimuth Rx antennas
*
* @param[in] numVirtualAntElev Number of virtual elevation Rx antennas
*
* @param[in] numDopplerBins Number of Doppler bins
*
* @param[in] numRangeBins NUmber of Range bins
*
* @param[in] minRangeIdx minimum range index to be exported
*
* @param[in] maxRangeIdx maximum range index to be exported
*
*
* @param[in] groupInDopplerDirection peak grouping in Doppler direction 0-disabled, 1-enabled
*
* @param[in] groupInRangeDirection peak grouping in Range direction 0-disabled, 1-enabled
*
* @return numObjOut Number of selected objects
* -<em>false</em> fail
* -<em>true</em> succeed
*
*/
bool postDetectionProcessing(uint32_t numDetectedObjects,
uint16_t* detBuffptr,
cfarDetOutput_t* cfarObjptr,
uint32_t* fftBuffptr,
MmwDemo_detectedObj *objOut,
uint32_t *dstPtrAzim,
uint32_t *dstPtrElev,
uint32_t numTxAnt,
uint32_t numRxAnt,
uint32_t numVirtualAntAzim,
uint32_t numVirtualAntElev,
uint32_t numDopplerBins,
uint32_t numRangeBins,
uint32_t minRangeIdx,
uint32_t maxRangeIdx,
uint32_t groupInDopplerDirection,
uint32_t groupInRangeDirection);
结构体注释规范
/**
* @brief
* Millimeter Wave Demo MCB
*
* @details
* The structure is used to hold all the relevant information for the
* Millimeter Wave demo
*/
typedef struct MmwDemo_MCB_t
{
/*! @brief Configuration which is used to execute the demo */
MmwDemo_Cfg cfg;
/*! @brief CLI related configuration */
MmwDemo_CliCfg_t cliCfg;
/*! @brief CLI related configuration */
MmwDemo_CliCommonCfg_t cliCommonCfg;
/*! * @brief Handle to the SOC Module */
SOC_Handle socHandle;
/*! @brief UART Logging Handle */
UART_Handle loggingUartHandle;
/*! @brief UART Command Rx/Tx Handle */
UART_Handle commandUartHandle;
/*! @brief This is the mmWave control handle which is used
* to configure the BSS. */
MMWave_Handle ctrlHandle;
/*! @brief Data Path object */
MmwDemo_DataPathObj dataPathObj;
/*! @brief Demo Stats */
MmwDemo_Stats stats;
/*! @brief this structure is used to hold all the relevant information
for the mmw demo LVDS stream*/
/*Unverified code. Conflicts with data path processing and should not be used.*/
MmwDemo_LVDSStream_MCB_t lvdsStream;
} MmwDemo_MCB;
枚举注释规范
/// \brief xxx枚举变量的简要说明
///
/// xxx枚举变量的详细说明--枚举变量的详细说明和函数的详细说明
///的写法是一致的。每个枚举变量下可以进行单独说明
enum{
em_1,///< 枚举值1的说明
em_2,///< 枚举值2的说明
em_3 ///< 枚举值3的说明
};
文件注释规范
/*!
* \file Ctext.h
* \brief 概述
*
*详细概述
*
* \author 作者名字
* \version 版本号(maj.min,主版本.分版本格式)
* \date 日期
*/