与 Doxygen 中的多个函数共享数据格式规范

Question

给出这样的东西：

/**
 * @brief FuncA
 *
 * Data format:
 * INT32 Date
 * INT32 Time
 * FLOAT Value
 *
 */
void funcA()
{}

/**
 * @brief FuncB
 *
 * Data format:
 * INT32 Date
 * INT32 Time
 * FLOAT Value
 *
 */
void funcB()
{}

如何提取数据格式规范，使其不会在多个地方重复？我想要的是这样的：

/**
 * @magictag Data Format
 *
 * INT32 Date
 * INT32 Time
 * FLOAT Value
 */

/**
 * @brief FuncA
 *
 * Data format:
 * @ref DataFormat
 *
 */
void funcA()
{}

/**
 * @brief FuncB
 *
 * Data format:
 * @ref DataFormat
 *
 */
void funcB()
{}

我只想拥有一个可以从任意位置引用的通用文档。谢谢

Answer 1

doxygen当前版本为1.8.16，建议升级到该版本。对于 1.8.11 版，\snippetdoc 不起作用（此版本中不存在该命令）。

\copydetails的例子：

/** \file */

/**
 * @brief FuncA
 *
 * Data format:
 * - INT32 Date
 * - INT32 Time
 * - FLOAT Value
 *
 */
void funcA();

/**
 * @brief FuncB
 *
 * @copydetails funcA
 */
void funcB();

\snippetdoc的例子：

/** \file */

/**
 * @brief FuncC
 *
 * @snippetdoc this snip_data
 *
 */
void funcC();

/**
 * @brief FuncD
 *
 * @snippetdoc this snip_data
 */
void funcD();


/*
 [snip_data]
  Data format:
  - INT32 Date
  - INT32 Time
  - FLOAT Value
 [snip_data]
*/

与 Doxygen 中的多个函数共享数据格式规范

Share data format spec with multiple functions in Doxygen

doxygen