0

doxygen HTML ドキュメント内の関連する 2 つの定義マクロを、1 つの説明ボックスに表示されるように接続したいと考えています。

それがどのように見えるべきかを明確に説明できることを願っています: 通常、すべての define ステートメントは、 を使用して独自の説明ボックスを取得します/** @define <description> */。これにより、ボックスのタイトル行にコード部分が表示され、ボックスの内容に短い説明が表示される説明ボックスが表示されます。

ここでやりたいことは、2 つの define ステートメントを接続して、それらが共通の説明を持つ 1 つのボックスに表示されるようにすることです。誰かがそれを実現する方法を知っていますか?

PS: この ASCII グラフィックを使用すると、少しわかりやすくなります。

+-------------------------+ | #define PORT 1 | | #define PORTDIR 0 | +-------------------------+ | output port definitions | +-------------------------+

4

1 に答える 1

0

を使用して #define をグループ化できます@name @{ .. @}。ここに小さな例があります。SUBGROUPING構成ファイルで にも設定すると、最もよく見えNOます。

/** @file
 *  File documentation
 */

/** @name Output ports definitions
 *  @brief Brief description for the group.
 *  @{
 */
#define PORT    1 /**< @brief The port number */
#define PORTDIR 0 /**< @brief The port direction */
/** @} */

/** @brief A lonely macro */
#define LONELY  2

個々のマクロのドキュメントを省略すると、要求した内容に近づくことができます。ドキュメントのみがグループの上にあり、グループの下にはありません。

于 2015-08-13T19:43:12.017 に答える