我可以在 doxygen @ref 中使用反引号和括号吗?

问题描述

我想在我的 C++ 代码中使用 doxygen 注释来引用某个函数;比如说,在不同的命名空间中:foo::bar()。让我们忽略这个函数被重载的可能性。而且我还希望函数名称的设置方式与我的 doxygen 注释中反引号内的内容相同。

考虑到这一点,以下哪项应该会产生我所描述的效果

@ref foo::bar
@ref foo::bar()
@ref `foo::bar`
@ref `foo::bar()`

或者 - 也许是别的东西?

解决方法

\ref 命令的文档说明:

\ref ["(文本)"]

创建对命名部分、子部分、页面或锚点的引用。对于 HTML 文档,参考命令将生成指向该部分的链接。对于一节或小节,该节的标题将用作链接的文本。对于锚点,将使用引号之间的可选文本,或者如果未指定文本。对于 LATEX 文档,参考命令将为节生成节号,或者如果引用锚点,则生成后跟页码的文本。

对于 \ref 命令,第一个参数是 <name>,而 <name> 不能包含反引号。

要获得所需的单间隔链接的可能性,可以为 HTML(仅!)调整/扩展样式表中使用的条目。

作为初学者:
在默认的 doxygen 样式表 doxygen.css 中,我们有:

a.el {
        font-weight: bold;
}

通过将此条目更改为例如

a.el {
        font-family: monospace,fixed;
        font-weight: normal;
}

最好不要重新定义 doxygen.css 并将其作为设置 HTML_STYLESHEET, 但是创建一个新的额外样式表并在 HTML_EXTRA_STYLESHEET 中指定它。

请注意,这将影响所有链接,而不仅仅是 \ref 链接。