Doxygen - сделать, чтобы все вхождения слова ссылались на одно и то же - PullRequest
Новая
       17

Doxygen - сделать, чтобы все вхождения слова ссылались на одно и то же

0 голосов
/ 20 августа 2011

Это относится к обычной странице документации.

Мне было интересно, можно ли в каждом вхождении слова сделать ссылку на что-то (в данном случае ссылка на документацию класса.

Пример 

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

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

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

и на странице, как вы читаете, вы можете нажать на слово Class, чтобы перейти к документации

1 Ответ

1 голос
/ 20 августа 2011

Если страница помещена в правильный контекст (пространство имен / пакет), то она должна работать, например, см. следующий пример (C ++): 

/** 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.
 */

Альтернативой будет использование 

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

Вместе со следующим определением псевдонима в файле конфигурации: 

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