Doxygen创建表格

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 S的添加到pin-assignments组。然后，您可以更详细地使用defgroup命令，例如记录本组：

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

More detailed description goes here. 
*/ 

（注：以上没有经过测试）