Doxygen @ref with custom text for link

Question

How would I go about naming a Doxygen @ref tag?

I have tried the following:

See @ref hello_world hello for more information

Which outputs this:

See hello_world hello for more information

Where hello_world is linked to hello_world. I am looking for this output:

See hello for more information

Where hello is linked to hello_world. The documentation for Doxygen only contains information about the LaTeX form of @ref (\ref), and I do not know how to apply that to the JavaDoc style @ref.

How would I go about changing the "text" value of the link?

From the documentation: nref <name> [”(text)”], so it looks like you missed the quotes: See @ref hello_world "hello for more information". — albert
– albert, Commented May 4, 2015 at 16:45
@albert That's it! @ref hello_world "hello" works. It'd be great if you could post that as an answer. — Jack Wilsdon
– Jack Wilsdon, Commented May 4, 2015 at 18:06

Top-Master · Accepted Answer · 2024-01-24 11:14:35Z

10

According to the documentation the syntax is: \ref <name> ["(text)"]

Were the [...] signs mean optional.

Hence it looks like you missed the quotes: See @ref hello_world "hello for more information".

edited Jan 24, 2024 at 11:14

Top-Master

9,0396 gold badges52 silver badges97 bronze badges

answered May 5, 2015 at 15:45

albert

9,2003 gold badges24 silver badges42 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Doxygen @ref with custom text for link

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related