vfl_freak
Premium-User
Hallo zusammen,
ich bin derzeit dabei eines meiner Projekte mit doxygen zu beackern ....
Dies hat jetzt nach mehrtägiger Fleißarbeit soweit geklappt, bis auf ein letztes typedef in einer DB-API-Schnittstelle
Folgende Stelle in einem Header zur Btrieve-DB wird noch angemeckert:
dies ergab die Warning:
Ich dachte ok, dann eben die beiden Werte flux drangehängt:
dieses ergab dann aber leider die Warnings:
Zugegebenermassen ist mir nicht so ganz klar, wie ich den TYPEDEF wirklich zu lesen habe ... und wie es dokumentieren muss, damit keine Warnings mehr auftreten!
Ich definiere doch den Funktionspointer BTI_CB_FUNC_PTR_T mit Rückgabetyp SHORT, oder nicht ?
Sind "bCallbackInfo" und "bUserData" keine Parameter?
Oder gibt es bei doxygen etwas Analoges zum "SuppressWarning" in Java****
Danke im voraus und Gruß
Klaus
EDIT:
So, habe es jetzt immerhin soweit runterbrechen können:
ergibt
ich bin derzeit dabei eines meiner Projekte mit doxygen zu beackern ....
Dies hat jetzt nach mehrtägiger Fleißarbeit soweit geklappt, bis auf ein letztes typedef in einer DB-API-Schnittstelle
Folgende Stelle in einem Header zur Btrieve-DB wird noch angemeckert:
C++:
/*!
\typedef short (APIENTRY *BTI_CB_FUNC_PTR_T) (BTI_CB_INFO_T *bCallbackInfo, void* bUserData)
*/
typedef short (APIENTRY *BTI_CB_FUNC_PTR_T) (BTI_CB_INFO_T *bCallbackInfo, void* bUserData);
D:/.../Btitypes.h:74: Warning: Member bUserData (typedef) of file Btitypes.h is not documented.
D:/.../Btitypes.h:74: Warning: Member short(APIENTRY *BTI_CB_FUNC_PTR_T)(BTI_CB_INFO_T *bCallbackInfo (function) of file Btitypes.h is not documented.
Ich dachte ok, dann eben die beiden Werte flux drangehängt:
C++:
/*!
\typedef short (APIENTRY *BTI_CB_FUNC_PTR_T) (BTI_CB_INFO_T *bCallbackInfo, void* bUserData)
\param bCallbackInfo = CallbackInfo
\param bUserData = UserData
*/
typedef short (APIENTRY *BTI_CB_FUNC_PTR_T) (BTI_CB_INFO_T *bCallbackInfo, void* bUserData);
D:/.../Btitypes.h:76: Warning: Member bUserData (typedef) of file Btitypes.h is not documented.
D:/.../Btitypes.h:73: Warning: argument 'bCallbackInfo' of command @param is not found in the argument list of short(APIENTRY *BTI_CB_FUNC_PTR_T)
D:/.../Btitypes.h:73: Warning: argument 'bUserData' of command @param is not found in the argument list of short(APIENTRY *BTI_CB_FUNC_PTR_T)
D:/.../Btitypes.h:73: Warning: The following parameters of short(APIENTRY *BTI_CB_FUNC_PTR_T) are not documented: parameter 'BTI_CB_FUNC_PTR_T'
Zugegebenermassen ist mir nicht so ganz klar, wie ich den TYPEDEF wirklich zu lesen habe ... und wie es dokumentieren muss, damit keine Warnings mehr auftreten!
Ich definiere doch den Funktionspointer BTI_CB_FUNC_PTR_T mit Rückgabetyp SHORT, oder nicht ?
Sind "bCallbackInfo" und "bUserData" keine Parameter?
Oder gibt es bei doxygen etwas Analoges zum "SuppressWarning" in Java****
Danke im voraus und Gruß
Klaus
EDIT:
So, habe es jetzt immerhin soweit runterbrechen können:
C++:
typedef short (APIENTRY *BTI_CB_FUNC_PTR_T) (BTI_CB_INFO_T *bCallbackInfo, void* bUserData); /*!< <i>typedef</i> */
D:/.../Btitypes.h:76:Warning: Member short(APIENTRY *BTI_CB_FUNC_PTR_T)(BTI_CB_INFO_T *bCallbackInfo (function) of file Btitypes.h is not documented.
Zuletzt bearbeitet von einem Moderator: