Doxygen 重复文本

Question

在我所有的 API 中，我都有一行重复的文本。有没有办法将该文本放在一个地方并从 API link 到它？

例如，在下面的示例中，如何将 'text that is common for many APIs' 放在一个地方，而不是在所有 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);

Answer 1

如果总是在同一行，最好是在doxygen配置文件（Doxyfile）中通过别名为其定义一个特殊命令，参见标签ALIASES

对于较长的文本，doxygen 命令 \includedoc 是可行的方法。

Doxygen 重复文本

Doxygen repeating text

doxygen