Ist es möglich, einen benutzerdefinierten Objekttyp in Doxygen zu erstellen?

Question

Ich möchte Doxygen verwenden, um eine HTTP-API zu dokumentieren und Beschreibungen von HTTP-Abfragen mit Parametern zu erhalten, Ergebnisse zurückgeben usw., ähnlich der Beschreibung von Klassen. Was ich brauche, ist ein Strukturbefehl \query, dem \brief, \param, \return usw. folgen kann und im oberen Navigationsmenü eine entsprechende Registerkarte "Abfragen" hat. Mit anderen Worten, ich brauche eine 100% ige Replikation von \class, aber einfach mit einem anderen Namen. Ist das möglich und wie?

Answer 1

Denken Sie nicht, dass es möglich ist, dies so sauber zu machen, wie Sie hoffen, aber eine Möglichkeit, dies zu erreichen, ist die Verwendung von Gruppen.

/** 
* \defgroup query Queries 
*/ 

dokumentieren Dann jede Abfrage als eine Gruppe in der query Gruppe

/** 
* \defgroup getUser Get User by Id 
* \ingroup query 
* \brief Some brief 
* \param Id user id 
* \return User for given id 
*/ 

Sie jetzt brauchen, um eine Registerkarte der query Gruppe im Navigationsmenü hinzuzufügen.

Zuerst generieren Sie eine Doxygen-Layout-Datei mit doxygen -l. Dann in Ihrem Doxyfile Set LAYOUTFILE = DoxygenLayout.xml.

Schließlich Ihre DoxygenLayout.xml Datei ändern, um die neuen Registerkarte hinzuzufügen:

<navindex> 
    ... 
    <tab type="user" visible="yes" title="Queries" url="@ref query" intro=""/>