【问题标题】:Can I employ back-ticks and parentheses with doxygen @ref?我可以在 doxygen @ref 中使用反引号和括号吗?
【发布时间】:2021-02-24 22:31:06
【问题描述】:

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

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

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

或者——也许是别的什么?

【问题讨论】:

  • "我应该使用以下哪个?"是基于我的想法。有什么作用?什么没有?哪个版本的 doxygen。
  • @albert:澄清我想知道其中哪些应该起作用。
  • 好吧,最后 2 个发出警告,因为它们不包含有效标签。
  • @albert:但是前两个不是导致链接文本不是等宽的吗?
  • 它们具有 doxygen.css 文件中定义的字母类型/样式。请参阅 doxygen.css 中的 a.el(在我的情况下是第 216 行)。

标签: comments doxygen code-documentation cross-reference backticks


【解决方案1】:

\ref 命令的文档说明:

\ref ["(文本)"]

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

\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 链接。

【讨论】:

  • a.el 是否仅用于由于@ref@see 而生成的链接?或者也指向其他链接?
  • 也适用于其他链接
  • 我明白了。那么我无法更改特定@ref/@see 链接的样式吗?还是其中的一部分?
  • 不是真的,只是在 doxygen 错误跟踪器中创建一个增强请求。唯一能想到的是使用和ALIAS\htmlonly\anchor 结合使用,但这将非常困难和棘手,我不确定这会导致结果。
猜你喜欢
  • 2012-10-24
  • 1970-01-01
  • 1970-01-01
  • 2011-01-08
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2010-11-05
相关资源
最近更新 更多