CでのDoxygenでの関数ポインタ処理

Question

私のコードでは、vtableにいくつかの関数ポインタが含まれています。 Doxygenはそれらに従うことができません。

私は今、この部分が欠けているので、完全なコールグラフを生成するために、可能なパスを認識するようにしたいと思います。

例：これはおそらくdoxygenは、コールグラフには影響を与えませんが

typedef Bool(*SPECIAL_FUNC)(KEY key); 

typedef struct{ 
    int a; 
    int b; 
    SPECIAL_FUNC; 
}OBJ; 

Bool add(KEY key); //code... 
Bool sub(KEY key); //code... 

Answer 1

、あなたが構造に関連するような機能を文書化し、SPECIAL_FUNCのドキュメントでそれらへのリンクを提供することができます。ような何か：

これにより

typedef Bool(*SPECIAL_FUNC)(KEY key); 

/** 
* struct description 
*/ 
typedef struct{ 
    int a; 
    int b; 

    /** 
    * Function pointer to one of the following: 
    * - add() 
    * - sub() 
    */ 
    SPECIAL_FUNC; 
}OBJ; 

/** 
* @relates OBJ 
* add function. 
*/ 
Bool add(KEY key); //code... 

/** 
* @relates OBJ 
* sub function. 
*/ 
Bool sub(KEY key); //code... 

は、OBJはクラスとして文書化され、addとsubはOBJの関連メンバーとして表示され、SPECIAL_FUNCのドキュメントはaddとsubへのリンクが含まれています。

Answer 2

私はこれを行うことはできないと思っていますが、これを偽造する方法の1つは、これを特別に定義し、Doxygen（PREDEFINED）を設定することだけです。

など。

#ifdef MY_DOXYGEN_FAKE 
    KEY key; 
    add(key); 
    sub(key); 
#endif 

この関数ポインタを使用する関数では、もちろん、関数から実際に使用する関数への呼び出しだけを追加する必要があるので、より多くの作業が必要です。しかし、もう一度ははどのような場合でもその関数ポインタがどのように使われるべきかを知っているはずです。