一个函数一般需要如下的doxygen描述它,当然里面的部分选项是可以忽略的。
/**
* @ingroup
* @brief
* @remark
* @param
* @return
* @retval
* @see
* @exception
* @deprecated
* @since
*/
returning_value your_function( args ... );
/**
* @ingroup
* @brief
* @remark
* @param
* @return
* @retval
* @see
* @exception
* @deprecated
* @since
*/
returning_value your_function( args ... );