c - 带有修饰符的 Doxygen 和 C 函数名称

Question

我正在记录一些嵌入式 C 代码，并且一些函数具有特定于编译器的存储修饰符，如下所示：

int chess_storage(x0) firmware_function(unsigned long int chess_storage(a0) param)

因为指令有一个参数，Doxygens 将指令解释为函数名。

通常的解决方案是使用PREDEFINEDDoxyfile 中的指令，如Doxygen 手册中所述：预处理和此邮件列表帖子以完全忽略存储修饰符：

PREDEFINED             = chess_storage(x)=

这种方法的问题是文档不准确，因为实际函数确实具有该修饰符。

我也尝试过使用@fn，但也没有用。

/**
 * @fn int firmware_function(unsigned long int param);
 *
 * A C function with a modifier
 *
 * @param param A parameter
 * @return zero.
 */
int chess_storage(x0) firmware_function(unsigned long int chess_storage(a0) param);

所以这里的目标不是忽略参数，而是让 Doxygen 意识到它只是一个词。

标签： cembeddeddoxygen