如何用多个库管理Doxygen项目？

我正在使用多个库项目，在结构设置，像这样：如何用多个库管理Doxygen项目？

/src目录
/库/ libOne
/库/ libTwo

我要生成一个单一的Doxygen页面涵盖了我所有的代码以及库。这很简单，只需将Doxygen指向根。但是，我希望将doxygen输出分组，以便我可以清楚地看到每个类/文件属于哪个库。但是，由于这些库不是由我编写的，我不想修改它们来添加\ addtogroup注释。

我不介意如果生成的文档对于库是不合适的（例如，如果它们不包含兼容doxy的注释），我还是希望它们包含在内，以便我可以查看调用图并快速浏览这些类，等等。

如何将每个库代码分组为模块而不更改库的源代码？

谢谢

来源

2010-05-25 bramp

你应该把所有必要的文件放在外部文件中。我不知道如何做到这一点，但我试图建立一个像你一样的最小环境，它运作良好。只是为了记录的东西，我抓起Doxygen的网站示例代码：

test1.h：

#define MAX(a,b) (((a)>(b))?(a):(b)) 
typedef unsigned int UINT32; 
int errno; 
int open(const char *,int); 
int close(int); 
size_t write(int,const char *, size_t); 
int read(int,char *,size_t);

并且写了完全无用test2.h（只是有两个不同的文件......）：

void itdoesnothing();

这里是很好的部分。我做了一个外部头只是为了记录上面，把它称为test_doc.h（再次，只是用在Doxygen的网站为例）：

/*! \addtogroup everything The main group 
    This group contains everything. 
    @{ 
*/ 

/*! \file test.h 
    \brief A Documented file. 

    Details. 
*/ 

/*! \def MAX(a,b) 
    \brief A macro that returns the maximum of \a a and \a b. 
    Details. 
*/ 

/*! \var typedef unsigned int UINT32 
    \brief A type definition for a . 
    Details. 
*/ 

/*! \addtogroup err Error handling 
Error handling related stuff 
@{ 
*/ 

/*! \var int errno 
    \brief Contains the last error code. 
    \warning Not thread safe! 
*/ 

/*! @} */ 

/*! \addtogroup fdrelated File description related 
    File descriptor related stuff. 
    @{ 
*/ 

/*! \fn int open(const char *pathname,int flags) 
    \brief Opens a file descriptor. 

    \param pathname The name of the descriptor. 
    \param flags Opening flags. 
*/ 

/*! \fn int close(int fd) 
    \brief Closes the file descriptor \a fd. 

    \param fd The descriptor to close. 
*/

这成功地证明这两个文件的Doxygen。这样，您就可以组文件，命名空间等也按照手册中的规定：

一组的成员可以是文件，命名空间，类，函数，变量，枚举类型定义，并界定，而且其他组。

因此，请尝试阅读http://www.doxygen.nl/grouping.html，看看我上面提到的事情有什么可能做。祝你好运！

来源

2010-05-25 21:20:57 Scorchio

非常感谢您的回答。我会尽快尝试，如果有效，请接受您的答案。 – bramp 2010-05-26 19:07:40

谢谢，这对我来说很好！ – bramp 2010-06-11 14:30:45

你是说你必须明确地添加每个类/函数/等到一个组？现有的代码库听起来很可怕......还是有捷径？就像告诉它所有文件（或理想的目录）在同一个组中一样？ – 2010-06-17 13:36:02

如何用多个库管理Doxygen项目？

回答

相关问题