Doxygen - 记录结构变量但不记录结构

Question

假设我有这个结构类型：

typedef struct Hidden Hidden;
struct Hidden
{
    int foo;
    int bar;
};

然后我有一个全局变量

Hidden visible;

Hidden 不应该被使用，visible 应该是Hidden 类型的唯一声明。我不想为Hidden 生成文档，因为我不想使用它，而是为visible 生成文档，其中包含有关它及其字段的所有信息。

我发现最接近的事情是，当您记录一个没有标签的struct 时：

struct
{
    int foo; ///< Number of particals in the universe.
    int bar; ///< Number of socks in the drawer.
} Baz; ///< Nameless struct variable.

Doxygen 会生成

struct {
   int foo
       Number of particals in the universe. 
   int bar
       Number of socks in the drawer. 
} Baz
  Nameless struct variable. 

这是我想要实现的目标，但我不能使用无名结构。

这样的事情可能吗？

Answer 1

我找到了一种方法。使用@RBE 建议的预处理器预定义可以让您仅为 doxygen 创建代码，无论如何都不会编译。因此，只需执行此操作（并将 DOXYGEN 设为预定义宏）：

typedef struct Hidden Hidden;

#ifdef DOXYGEN

struct
{
    int foo; ///< Number of particals in the universe.
    int bar; ///< Number of socks in the drawer.
} visible; ///< Nameless struct variable!

#endif

struct Hidden
{
    int foo;
    int bar;
};

Hidden visible;

这很hacky，但它可以工作。

Answer 2

做你想做的最简单的方法是使用宏定义在你将编译的代码和你将运行 doxygen 的代码之间切换：

#define DOXYGEN

#ifdef DOXYGEN
/**
 *  @brief Describe your visible structure here.
 */
typedef struct VISIBLE
{
    int foo; //< Number of particles in the universe.
    int bar; //< Number of socks in the drawer.
} VISIBLE;
#else
typedef struct HIDDEN
{
    int foo;
    int bar;
} HIDDEN;

HIDDEN visible;
#endif

只需注释或取消注释DOXYGEN 定义即可从一个切换到另一个。