6

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?

Jack Wilsdon
  • 6,706
  • 11
  • 44
  • 87
  • From the documentation: nref [”(text)”], so it looks like you missed the quotes: See @ref hello_world "hello for more information". – albert May 04 '15 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 May 04 '15 at 18:06

1 Answers1

8

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

albert
  • 8,285
  • 3
  • 19
  • 32