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

（注：以上沒有經過測試）