Warning: file_get_contents(/data/phpspider/zhask/data//catemap/0/jpa/2.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Tcl 使用Doxygen定制/分发更改文档_Tcl_Doxygen_Documentation Generation - Fatal编程技术网

Tcl 使用Doxygen定制/分发更改文档

Tcl 使用Doxygen定制/分发更改文档,tcl,doxygen,documentation-generation,Tcl,Doxygen,Documentation Generation,我正在尝试使用Doxygen获得以下功能 这可能吗?如何最好地做到这一点 我们正在使用EDA工具附带的现有Tcl代码库,其中很多代码都是“源代码”的代码,不一定在过程中组织。我们对这个代码库进行了大量的改进/修改。示例自定义的形式为允许使用新配置变量Y控制功能X,并涉及对fileA、fileB和fileC的修改 我让Doxygen解析整个代码库。除了标准语言文档外,我还希望提取我们所做的所有定制的列表,包括修改了哪些文件和大致的行号,每个文件中做了哪些更改,从每个文件中捕获修改后的代码,以及指向

我正在尝试使用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
#
这允许从三个位置收集评论,但我不知道如何:

包括下面的部分源代码,以及 如何使生成的文档包含对注释来源的文件/行号的引用 使用xrefitem而不是page将提供摘要页面和源之间的链接

若要在页面中包含代码段,代码段可能会有所帮助

例如:

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

埃里克,这看起来很有希望。如果没有\page引用,Doxygen会将标记为\xrefitem的注释内容放在哪里?Doxygen会为每个不同的xrefitem标记自定义创建一个页面1在我的示例中,我似乎无法让Doxygen生成与\xrefitem甚至\todo相关的任何内容。它使用这些指令解析文件,并包含从中提取的其他信息。我在配置中设置了以下所有选项:GENERATE\u TODOLIST=YES GENERATE\u TESTLIST=YES GENERATE\u BUGLIST=YES GENERATE\u DEPRECATEDLIST=YES似乎DoxyGen仅捕获\xrefitem及其派生示例\todo,如果它们与可识别的代码元素类、过程、命名空间关联,ext.\xrefitem单独存在的任何时候,甚至当它位于\page内时,都会被DoxyGen忽略@ric malenfant,有什么办法解决这个问题吗?对不起@eric,上面我拼错了你的名字。