Doxygen - 如何链接到C ++文件范围的全局变量

Question

我有一些看起来像这样的代码：

MyStruct.h

struct MyStruct
{
    // ...

    /**
      * \brief Initializes \link MYSTRUCT \endlink.
      */
    static void init();
};

/**
 * \var MYSTRUCT
 * \brief You must call MyStruct::init() before using this variable.
 */
extern MyStruct const * MYSTRUCT;

问题

我希望MyStruct::init上的Doxygen文档链接到MYSTRUCT上的Doxygen文档。但是，Doxygen无法解析我提供的链接。我需要做些什么才能使链接正常工作？

注意：Windows 7上的Doxygen v 1.8.4

Answer 1

以下是应该有效的更正示例。请注意，我添加了一个带有\ file的注释块（并删除了多余的\ var）

/** \file */

/** My struct documentation */
struct MyStruct
{
    // ...

    /**
     * \brief Initializes \link MYSTRUCT \endlink.
     */
    static void init();
};

/**
 * \brief You must call MyStruct::init() before using this variable.
 */
extern MyStruct const * MYSTRUCT;

如果您不想要一个包含全局数据的页面，但希望MYSTRUCT显示为MyStruct文档的一部分，您可以使用\ related，如下所示：

/** My struct documentation */
struct MyStruct
{
  // ...

  /**
   * \brief Initializes \link MYSTRUCT \endlink.
   */
  static void init();
};

/**
 * \brief You must call MyStruct::init() before using this variable.
 * \relates MyStruct
 */
extern MyStruct const * MYSTRUCT;

您可以使用#MYSTRUCT作为\link MYSTRUCT \endlink

的简写符号