Doxygen @ref 带有链接的自定义文本

问题描述 投票:0回答:1

我该如何命名 Doxygen

@ref
标签?

我尝试过以下方法:

See @ref hello_world hello for more information

哪个输出:

See hello_world hello for more information

其中

hello_world
链接到
hello_world
。我正在寻找这个输出:

See hello for more information

其中

hello
链接到
hello_world
。 Doxygen 的文档仅包含有关 LaTeX 形式的信息
@ref
(
\ref
),我不知道如何将其应用到 JavaDoc 风格
@ref

我该如何更改链接的“文本”值?

syntax documentation doxygen documentation-generation
1个回答
9
投票

根据文档,语法为:

\ref <name> ["(text)"]

[...]
符号是否表示可选。

因此看起来您错过了引号:

See @ref hello_world "hello for more information"

© www.soinside.com 2019 - 2024. All rights reserved.