Question

我正在尝试生成一个doxygen文档，其中我有两个函数文档实例。一个描述了从.h文件中的函数头中提取的函数的用法（接口），另一个描述了从.c文件中提取的函数的实现。我基本上想要根据描述来自的文件（.h或.c）以两种不同的方式描述相同的功能。我认为这有助于文档的可用性，因为如果您只关心如何使用这些函数，您可以轻松忽略实现细节。我最好的尝试是尝试将.h和.c文件添加到这样的单独组中。

example.h文件

/**
 * @defgroup exampleInterface Example Interface
 * @{
 */

/**
 * This is the header file so I describe how to use this function
 * @param arg
 * @returns something
 */   
 int someFunction(int arg);

/**
* @}
*/

示例.c

/**
 * @defgroup exampleImpl Example Implementation
 * @{
 */

/**
 * This is the .c file so I describe how this function is implemented.
 */   
 int someFunction(int arg)
 {
    ... Some code ...
 }
/**
 * @}
 */

结果是函数头描述仍然合并在一起。无论如何在doxygen中实现这一目标？也许还有另一种方法我应该看看这个问题。

感谢。

Answer 1

你可以尝试的一个可能的黑客是使用@internal命令进行实现，这意味着你将运行doxygen两次：一次没有内部（用于外部定义），另一次用inernal来组合它们。 / p>

doxygen独立接口（.h）/实现（.c）文档

1 个答案: