CODEWITHSUNDEEP
syntaxdocumentationdoxygendocumentation-generation
Jack Wilsdon
Jack Wilsdon

Reputation: 7045

Doxygen @ref with custom text for link

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?

Upvotes: 7

Views: 6735

Answers (1)

albert
albert

Reputation: 9077

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".

Upvotes: 9

Related Questions