Question

我有一个多人编写和编辑的程序。程序的某些部分将软件值链接到用户指定的特定引脚。正在使用的引脚分布在多个文件之间，我想创建一个中心引用。我想使用doxygen创建一个列出引脚号的引用，然后是指定目的。所有引脚分配都在头文件中定义，如下所示：

//spi1.h
// Pin assignments (GPIO row A)
#define SPI_SS_1            (0)
#define SPI_CLK_1           (1)
#define SPI_MOSI_1          (2)
#define SPI_MISO_1          (3)

//spi2.h
// Pin assignments (GPIO row A)
#define SPI_CLK_2           (7)
#define SPI_DOUT_2          (8)
#define SPI_DIN_2           (9)
#define SPI_CS_2_0          (10)
#define SPI_CS_2_1          (11)
#define SPI_CS_2_2          (12)
#define SPI_CS_2_3          (13)

我如何使用doxygen为这些值创建参考图表？

Answer 1

您可以使用doxygen grouping mechanisms将这些#define组合在一起。从这个页面：

要定义组，您应该将\defgroup命令放在特殊注释块中。该命令的第一个参数是一个唯一标识该组的标签。第二个参数是组中的名称或标题，它应该出现在文档中。

您可以通过在其文档块中放置\ingroup命令，使实体成为特定组的成员。

为避免在每个成员的文档中添加\ingroup命令，您还可以通过组前面的空心标记@{和成员后面的结束标记@}将成员分组在一起。标记可以放在组定义的文档中，也可以放在单独的文档块中。

在实践中，您可以在每个头文件中添加如下内容：

/** \addtogroup pin-assignments
 *  @{
 */
#define SPI_SS_1            (0)
#define SPI_CLK_1           (1)
#define SPI_MOSI_1          (2)
#define SPI_MISO_1          (3)
/** @}*/

将上述#define中的每一个添加到pin-assignments组。然后，您可以使用defgroup命令更详细地记录此组，例如：

/** \defgroup pin-assignments Pin assignments (GPIO row A) 

More detailed description goes here.
*/

（注意：以上未经测试）

Doxygen创建表

1 个答案: