2013-02-22 33 views
0

我试图生成一个doxygen文档,其中有两个文档实例的功能。一个描述从.h文件中的函数头获取的函数的用法(接口),另一个描述从.c文件获取的函数的实现。基本上我想基于描述来自哪里的文件(.h或.c)以两种不同的方式来描述相同的功能。我认为这将有助于文档的可用性,因为如果您只关心如何使用这些功能,您可以轻松地忽略实现细节。我最好的尝试是尝试添加.h和.c文件来分隔这样的组。doxygen单独的接口(.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中完成这个任务吗?也许还有另一种方式我应该看看这个问题。

谢谢。

回答

0

你可以尝试的一种可能的方法是使用@internal命令来执行,这意味着你可以运行doxygen两次:一次没有内部(用于外部定义),另一次用于内部结合它们的inernal。