使用Doxygen进行更改的自定义/分布式文档

时间:2014-04-14 14:19:48

标签: tcl doxygen documentation-generation

我试图让以下功能与Doxygen一起使用。

这可能,以及如何做到最好?

我们正在使用EDA工具附带的现有Tcl代码库,其中很多代码都来源于'并不一定按程序组织。我们已经对此代码库进行了许多改进/修改。示例自定义的形式为"允许使用新的配置变量Y"来控制功能X,并涉及对fileA,fileB和fileC的修改。

我有Doxygen解析整个代码库。除了标准语言文档,我希望提取我们所做的所有自定义列表,包括修改了哪些文件(和大致行号),在每个文件中进行了哪些更改,从每个文件捕获修改后的代码,以及指向文件列表和修改的行号。

我希望这需要在fileA,fileB和fileC中定制Doxygen注释/标签,而我设法得到的最接近的是在fileA fileB和fileC中修改某些内容的每个位置:

##
# \page custom_mypage1 Customization enabling control of X with variable Y
# 
# This is a test comment 1
#

这允许从三个地点收集评论,但我无法弄清楚如何:

  1. 包含以下源代码的一部分,
  2. 如何让生成的文档包含对评论来自的文件/行号的引用

1 个答案:

答案 0 :(得分:0)

使用xrefitem代替page将提供摘要页面和来源之间的链接。

要在页面中添加代码段,snippet可能会有帮助。

示例:

/**
\xrefitem customization1 "Change for 1" "Changes for customization1"
Description of change.
\snippet CurrentSourceFile.cpp change1
*/
//! [change1]
Modified code here...
//! [change1]