c++ - Doxygen:从页面链接到 C++ 类成员而不写类名

标签 c++ doxygen

假设我有一个类 Foo,它有一个成员函数 bar(),用 Doxygen 记录:

foo.h:

/// This is the Foo class.
class Foo
{
  /// Does something.
  void bar();
};

和一个单独文件中的页面,我想在其中引用 bar()(用 Markdown 编写):

notes.md:

To do something, call bar().

我希望生成页面中的“bar()”链接到bar() 函数的文档。我可以通过编写 Foo::bar() 来实现这一点,但我不希望它在页面中显示为“Foo::bar()”。实现这一目标的好方法是什么?

最佳答案

到目前为止,我找到的最佳解决方案是使用 \ref在 notes.md 中:

To do something, call \ref Foo::bar() "bar()".

不过,在我看来,这仍然有点困惑。与自动生成的链接不同,它也不会在鼠标悬停时显示功能的简要说明。

关于c++ - Doxygen:从页面链接到 C++ 类成员而不写类名,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/54662316/

相关文章:

javadoc - 适用于GNU M4语言的Doxygen

doxygen - 删除 PDF 中的 "generated by doxygen"和时间戳

c - 静态变量在不应该的时候出现在 Doxygen 文档中

c++ - 如何在 C++ 中使用 SDL2.0 在屏幕上移动矩形?

c++ - 如何从队列中获取前 5 个元素 C++

c++ - GTest - 将 Mock 函数参数传递给 ASSIGN()

C++ - 调试中的字符串 ID,发布中的 int

c++ - 如何在可变参数模板中声明 "implicit conversion"?

c - 如何让 doxygen 为 c 函数生成调用和调用者图

makefile - 记录 makefile 中使用的变量