Unable Dokumentation Funktionsdefinition von einigen Makro #defines gefolgt erzeugen

Question

ich eine CPP-Datei haben und festgestellt, dass Doxygen nicht in der Lage ist, eine Funktion zu dokumentieren, die das folgende Format enthält:

//! 
//! \brief Test 
//!  and perform operations on those points. 
//! 
void CTest::TestTri() 
EH_Start("CTest::TestTri") 
{ 
} 
EH_Stop 

Die EH_Start und EH_Stop sind ein Ausnahmebehandlungsmechanismus und verursacht Probleme.

Wie können wir diese ausschließen?

Answer 1

Versuchen Sie, ein expliziter doxygen-Format - die folgenden genau sagt, doxygen welche Funktion Sie dokumentieren möchten, so dass es muss nicht verstehen, den Code herauszufinden, was in der Dokumentation befestigen:

/// \fn void CTest::TestTri() 
/// \brief Test and perform operations on those points 
EH_STart("CTest::TestTri") {} EH_Stop 

Answer 2

EH_Start und EH_Stop sind Unter der Annahme definiert, können Sie diese Makros erweitern haben doxgen, wenn es den Code

EXPAND_AS_DEFINED = EH_Start EH_Stop 

Wir haben eine Reihe von Makros für die Funktion und Klassendeklarationen verarbeitet. Ohne EXPAND_AS_DEFINED erzeugen Doxygen nicht die korrekte Dokumentation

Zum Beispiel:

/* C++ Code */ 
#define STANDARD_CONSTRUCTORS_HEADER(iCLASS) \ 
    public: iCLASS(); \ 
    public: virtual ~iCLASS(); \ 
    private: iCLASS(const iCLASS & iCopy); \ 
    private: iCLASS& operator=(const iCLASS &); 

class Foo { 
    STANDARD_CONSTRUCTORS_HEADER(Foo) 
} 

/* Doxyfile */ 
EXPAND_AS_DEFINED = STANDARD_CONSTRUCTORS_HEADER 

ohne EXPAND_AS_DEFINED, Sie werden die Foo Konstrukteuren in der Dokumentation nicht bekommen.