【问题标题】:Insert link to function in another file with Doxygen?使用 Doxygen 在另一个文件中插入功能链接?
【发布时间】:2015-03-15 06:06:37
【问题描述】:

我有两个 C 源文件。对文件 A 中函数 bar() 的注释需要引用文件 B 中的函数 foo()。我怎样才能建立这个链接?

我试过了:

  1. 像这样写:B.c::foo() 希望 doxygen 会转到文件 B 并在那里找到函数 foo。

  2. 也尝试过简单的::foo(),但没有帮助。

  3. 然后我尝试为文件B.c 指定一个特殊的标记名,就像在B.c 的第一行执行//! @file specialtag 一样,然后在我的评论中执行specialtag::foo(),但变化不大。

  4. 我试图强制与\ref 和\link 建立链接,但即使这样也无济于事。

//! @file 行同时出现在 A.c 和 B.c 中,因此 doxygen 应该注意代码。

编辑

我尝试了@doxygen 的建议,但没有运气。我做了一个示例项目来显示我遇到问题的地方,它在这里:http://www.filedropper.com/testdoxygen2tar

我使用了由doxygen -g 制作的默认设置文件。 我得到的输出:

您可以看到 foobar 函数没有被链接到。

编辑 2

发现问题。函数foo 没有记录,因此没有生成它的页面,所以当然 doxygen 没有可链接的页面。 (我正在生成启用了SOURCE_BROWSER 选项的文档,并希望生成指向函数定义的链接)

【问题讨论】:

  • 我能想到的最好的就是文件的链接,用粗体字告诉用户在到达那里时查看函数。您可以自动链接,或使用@see。抱歉,这没有多大帮助。我想自己知道答案。如果这里没有运气,那么也许可以注册并将您的问题发布到 DoxyGen 用户邮件列表?

标签: c doxygen


【解决方案1】:

这很简单。这是一个使用默认配置文件 (doxygen -g) 的最小示例:

首先创建文件 foo.c,内容如下:

/** @file */

/** Function foo, see also bar(). */
void foo()
{
}

然后创建包含以下内容的文件 bar.c:

/** @file */

/** Function bar, see also foo(). */
void bar()
{
}

运行 doxygen 并在 HTML 输出中观察到两个函数都有指向另一个函数的链接。

【讨论】:

  • 我解决了这个问题。我在生成文档时启用了SOURCE_BROWSER 选项,并希望函数名称能将我带到它的源定义。
  • 如果您希望占位符链接到而不记录函数,您可以将 EXTRACT_ALL 设置为 YES。
  • 如果两个函数同名怎么办?
  • @beaver:这是一个不同的问题。幸运的是,它已经被问过了:-)。 Handling two different functions with the same name in Doxygen.
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2014-02-06
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2021-04-06
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多