Doxygen重复文字

时间:2018-06-27 13:07:28

标签: doxygen

在我所有的API中,我都会重复一行文本。有没有办法将这些文本放在一个地方并通过API链接到它?

例如,在下面的示例中,如何将“许多API通用的文本”放在一个地方,而不是在所有API中都写相同的东西?

/**                                                                            
 * @brief Function description                                        
 * @param [in] param function param description 
 * @return return description                                                         
 *                                                                              
 * @attention text that is common for many APIs
 ***********************************************************************/       
 int func(int param);

1 个答案:

答案 0 :(得分:1)

万一总是同一行,最好是通过doxygen配置文件(Doxyfile)中的和别名为其定义一个特殊命令,请参见标签ALIASES

对于较长的文本,可以使用doxygen命令\includedoc