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

发布于 2024-11-30 21:31:34 字数 314 浏览 0 评论 0原文

这是参考正常页面文档。

我想知道是否有可能使每个出现的单词都引用某些内容(在本例中链接到类文档。

示例

/**
@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 将您带到文档

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

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

微暖i 2024-12-07 21:31:34

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

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\""
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文