Doxygen - 使所有出现的单词引用相同

时间:2011-08-19 21:46:27

标签: documentation doxygen

这是对正常页面文档的引用。

我想知道是否有可能使每个单词引用出现一些东西(在这种情况下链接到类文档。

例如

/**
@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 个答案:

答案 0 :(得分:1)

如果页面放在正确的上下文(命名空间/包)中,那么它应该可以工作,例如请参阅以下(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\""