2

複数の人が作成および編集するプログラムがあります。プログラムの一部は、ソフトウェアの値をユーザーが指定した特定のピンにリンクします。使用中のピンは複数のファイルに分散されているため、1 つの中心的な参照を作成したいと考えています。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

#definedoxygen のグループ化メカニズムを使用して、これらをグループ化できます。このページから:

\defgroupグループを定義するには、コマンドを特別なコメント ブロックに入れる必要があります。コマンドの最初の引数は、グループを一意に識別するラベルです。2 番目の引数は、ドキュメントに表示されるグループの名前またはタイトルです。

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

（注：上記はテストされていません）

于 2012-04-23T21:16:42.930 に答える