一个大型多应用程序COM项目中Doxygen的最佳设置

5
一个系统最多有100个VC++项目,每个项目都会生成一个DLL或EXE。此外还有许多带有IDL和生成的.h/.c文件的COM组件。
使用Doxygen组织这些内容,应该采用哪种“正确”的方式或至少是一种好的方式?是一个整体的doxy项目,还是每个项目/解决方案一个?对于带有生成代码和大量“废话”的COM,应该如何处理,以避免生成的HTML文件变得臃肿?

我发现一些交叉点,尽管它不是完全重复的:https://dev59.com/uU7Sa4cB1Zd3GeqP0AUe - Mr. Boy
3个回答

1

我还没有试过这个,但是doxygen有能力链接到外部文档。我可能会做不同的项目,并尝试使用外部链接。否则,对于你描述的大量项目,单个doxygen构建可能需要非常长的时间。


1

如果您不希望某些文件出现在Doxygen输出中,可以使用EXCLUDE_PATTERNS指令。我参与的一个项目就使用了这个指令。

EXCLUDE_PATTERNS = */test/*

为了避免在 Doxygen 输出中包含我们的单元测试类,我们可以采取一些措施。如果您自动生成的 COM 文件有任何模式,您可以通过这种方式将它们排除在外。

0
我选择了几个独立的doxygen构建,如下所示:
  • 为主应用程序构建顶级lib,不包括库
  • 为每个库构建单独的“libs”文档
  • 可选地使用所有内容构建“全局”doxygen构建
  • 可选地使用“内部”开关构建libs。
  • 所有输出都包含在一个Doxygen文件夹中(Doxygen\applicationDoxyge\Lib1...
  • 顶级lib构建使用带有链接到库函数的“mainpage”,例如<a href="../_Lib1/html/index.html">Lib #1</a>
  • libs具有带有链接回顶级lib mainpage的mainpage:例如href="../../_TopLevel/html/index.html"

不确定COM的事情......

史蒂夫


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接