Doxygen列表未声明的功能

Question

我想用Doxygen记录汇编代码，我的想法是用\ fn定义汇编函数。但是Doxygen不会列出这些函数，因为它找不到声明。

我发现了该线程Doxygen: Force undeclared functions to be documented，但是我无法声明该C函数，因为如果这样做，我的汇编器将不会汇编我的文件。有没有办法强迫Doxygen列出用\ fn记录的函数，尽管它们没有被声明？

示例代码：

/*
 * \fn void pinSetup(int pin)
 *
 * \param pin   pin number
 */
pinSetup:
    mov r1, r0
    ...

Answer 1

技巧是向doxygen公开比编译器更多的“代码”。

例如，定义一个虚拟定义，使用doxygen构建时始终为true：

PREDEFINED = IN_DOXYGEN

并且在某些C代码中，添加一个伪造的函数，如下所示：

#ifdef IN_DOXYGEN
/**
  Doc for pinSetup.
  @param pin   pin number
*/
void pinSetup(int pin) { /* Implemented in asm */ }
#endif /* IN_DOXYGEN */