Überladene Funktionsdokumentation in Doxygen (C++)

Question

Ich versuche, einige Code zu dokumentieren, der für verschiedene Funktionen viele Überladungen hat. Diese Funktionen machen das Gleiche auf sehr unterschiedliche Weise.

Ich möchte alle diese Funktionen zusammen mit Doxygen, ähnlich wie in cppreference.com (example) getan dokumentieren.

Ist es möglich, ein ähnliches Verhalten in Doxygen zu bekommen? Wenn das so ist, wie?

Answer 1

Es gibt eine similiar Frage: Grouping overloads in doxygen

Ich denke, dass die erste Antwort, Ihre Frage beantwortet, wie es will Gruppe eine Reihe von Funktionen unter einem einheitlichen Namen. Ich habe es tatsächlich einen Versuch die folgenden Header mit:

#ifndef TEST_H 
#define TEST_H 
/** 
* @brief Test Class 
*/ 
class Test 
{ 
public: 
    ///Default Constructor 
    Test(); 
    /** 
    * @name Overloaded methods 
    */ 
    //@{ 
    ///OverLoad1 
    void func1(void); 
    /** 
    * @brief Overload2 
    * @param a test variable 
    */ 
    void func1(int a); 
    //@} 
}; 
#endif //TEST_H 

Wenn Sie Dokumentation mit doxy generieren, werden Sie sehen, dass die überladenen Methoden gruppiert werden in der kurzen Beschreibung.

Ich hoffe, dass hilft!