CODEWITHSUNDEEP
documentationdoxygen
Th3sandm4n
Th3sandm4n

Reputation: 809

Doxygen - make all occurrences of a word reference the same thing

This in reference to a normal page documentation.

I was wondering if it was possible to make each occurrence of a word reference something (in this case linking to a class documentation.

example

/**
@mainpage Blah
@re com.blah.class label = Class **(or something)**

If you notice Class does this.
...
...

This is because the way Class works...
...
@endmainpage
*/

and in the page, as you read, you can click into the word Class to take you to the documentation

Upvotes: 0

Views: 144

Answers (1)

doxygen
doxygen

Reputation: 14879

If the page is put in the right context (namespace/package) then it should work, e.g. see the following (C++) example:

/** A namespace */
namespace N
{
  /** A class */
  class C
  {
  };

  /** @mainpage My main page
   *  Class C is linked here!
   */
}

/** @page mypage A Page 
 *  Class C is not linked, but N::C is.
 */

An alternative would be to use

/** @page mypage A Page 
 *  Class @l{C} is not linked, but N::C is.
 */

Along with the following alias definition in the config file:

ALIASES                = l{1}="@ref N::\1 \"\1\""

Upvotes: 1

Related Questions