Question

我想在头文件中记录extern API，如下所示

foo()

函数\memberof定义在归档文件中的某处，“bar.h”作为用户API公开，我想记录它。但是doxygen无法产生它。我不想启用EXTRACT_ALL，因为还有其他一些我不想记录它的东西。

示例代码显示我已尝试(currTimeMilli - 18000000) % 864000000，但它不起作用。有人可以帮助我吗？

Answer 1

您至少需要使用\file来记录文件本身，以便生成任何内容。但不确定这是否足以生成extern函数的文档。

Answer 2

从@rveerd的提示中，我完成了答案。首先，它需要\file个命令来记录全局对象。在此步骤中，记录所有对象，包括我们不想记录的对象。所以我们需要通过添加\cond HIDDEN_SYMBOLS来丢弃我们不需要的部分。示例代码如下：

/** @file test.h */

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief This is foo
 */    
extern int foo();

/** @cond HIDDEN_SYMBOLS */
#define JUNK_A DONT_DOC_IT
#define JUNK_B DONT_DOC_IT
/** @endcond */

#ifdef __cplusplus
}
#endif

doxygen不能在c中产生extern api

2 个答案: