Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Naming a doxygen @ref

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?

like image 898
Jack Wilsdon Avatar asked May 03 '15 20:05

Jack Wilsdon


1 Answers

From the documentation: \ref <name> ["(text)"], so it looks like you missed the quotes: See @ref hello_world "hello for more information".

like image 145
albert Avatar answered Nov 15 '22 08:11

albert