0

関数のドキュメント インスタンスが 2 つある doxygen ドキュメントを生成しようとしています。1 つは、.h ファイルの関数ヘッダーから取得される関数の使用法 (インターフェイス) について説明し、もう 1 つは .c ファイルから取得される関数の実装について説明します。私は基本的に、説明の元となったファイル (.h または .c) に基づいて、同じ関数を 2 つの異なる方法で説明したいと考えています。関数の使用方法だけを気にする場合は、実装の詳細を簡単に無視できるため、これはドキュメントの使いやすさに役立つと思いました。私の最善の試みは、.h ファイルと .c ファイルをこのように別のグループに追加することでした。

たとえば .h

/**
 * @defgroup exampleInterface Example Interface
 * @{
 */

/**
 * This is the header file so I describe how to use this function
 * @param arg
 * @returns something
 */   
 int someFunction(int arg);

/**
* @}
*/

例 .c

/**
 * @defgroup exampleImpl Example Implementation
 * @{
 */

/**
 * This is the .c file so I describe how this function is implemented.
 */   
 int someFunction(int arg)
 {
    ... Some code ...
 }
/**
 * @}
 */

その結果、関数ヘッダーの説明がまだ結合されていました。doxygenでこれを達成する方法はありますか? この問題を別の方法で見る必要があるかもしれません。

ありがとう。

4

1 に答える 1