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

Question

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

我的结构

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;

问题

我想将 Doxygen 文档MyStruct::init链接到MYSTRUCT. 但是，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 文档的一部分出现，您可以像这样使用 \relates：

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