在doxygen文档中,如何创建指向文件特定行的链接

时间:2012-03-12 03:00:13

标签: line hyperlink doxygen

有几个doxygen命令,其目的是在文档中创建链接(@link@ref)。
我目前正在使用@ref命令创建一个自定义文件的链接,该文件是用doxygen(xml)不支持的语言编写的。
我想改变这个链接,使其指向文件中的精确行 是否有doxygen命令允许这样做?

1 个答案:

答案 0 :(得分:6)

我不确定\ref\link可以做到这一点。但是,如果可以的话,采用这种方法的一个问题是,如果在不更改链接的情况下更改要链接的文件的内容,链接将变为无效。这是分离源代码和文档的问题之一。

为什么不在文档中包含您感兴趣的文件的特定部分,而不是链接到另一个文件中的特定行?你可以:

  • 将整个文件包含\include(还有\includelineno),并在文本中引用相关部分(例如“下面代码中的函数xxx”)或
  • 使用\snippet在文档中包含您需要引用它们的文件的片段。

修改:或者,您可以使用\dontinclude命令,以及\line\skip\skipline和{{ 1}}命令允许您包含特定文件的特定行/块。请参阅\until文档中的示例。