2

我有一个多人编写和编辑的程序。程序的某些部分将软件值链接到用户指定的特定引脚。正在使用的引脚分布在多个文件之间，我想创建一个中心参考。我想使用 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 为这些值创建参考图表？

4

1 回答 1

3

您可以#define使用 doxygen 的分组机制将这些 s 组合在一起。从这个页面：

要定义一个组，您应该将\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)
/** @}*/

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

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

More detailed description goes here.
*/

（注：以上未经测试）

于 2012-04-23T21:16:42.930 回答