一篇完整的doxygen示例代码

首先是头文件：

 

/**
 * @file InfraredCtl.h 
 * @brief This is the header file that define interface that 
 *  	  control the infrared unit that used for detect
 *  	  distance between the X2 and the child.
 *  
 * @version 1.00 
 * 
 * @author Ryan 417638824@qq.com 
 *  
 * @date 2012-09-21 
 *  
 * 
 */

#ifndef	_INFRARED_CONTROL_H_2012_09_21_
#define	_INFRARED_CONTROL_H_2012_09_21_

/**
 * @brief This function is to set the level(means the diatance 
 *  	  that can be detected)
 *  
 * @param [in] level the value can be 0-7, the bigger of the 
 *  			value, the longer of the distance can be
 *  			detected
 *  
 * @return true meas the function execute success! 
 *  
 * @author Ryan 
 *  
 * @date 2012-09-21 
 */
bool	infraredCtlSetInvalidLevel(int level);


#endif