Doxygen - gleiche docstring für mehrere Methodenparameter

Angenommen, Sie die folgende Methode docstring + Erklärung haben:Doxygen - gleiche docstring für mehrere Methodenparameter

/**\brief What it does 
* \param[in] a docstring for a 
* \param[in] b same docstring as in a 
*/ 
void fun(
    const int& a 
    const int& b 
    int* c 
)

Gibt es eine Möglichkeit zur Herstellung a und b Funktionsparameter die gleiche docstring haben es ohne Duplizierung?

Ich habe versucht, sie in der \{ ... \} Syntax, wie in Funktionen mit dem gleichen Docstring, aber es scheint nicht zu arbeiten.

Vielen Dank im Voraus,

Quelle

2017-02-11 bergercookie

Haben Sie versucht, zu Doxygen Posting [Benutzer-Mailingliste] (https://sourceforge.net/p/doxygen/mailman/)? –

Was wäre der Zweck? Ich weiß nicht über dich, aber ich wäre verwirrt, wenn eine Funktion zwei Parameter hätte und beide die * gleiche * Dokumentation hätten. In der Tat würde ich einen Fehler in der Dokumentation vermuten. –

Ich weiß nicht, ob es möglich ist oder nicht, aber warum erstellen Sie nicht einfach eine Verknüpfung zu dem Parameter mit der Beschreibung, die Sie mit einem Anker wie diesem wiederverwenden wollen: 'Siehe {@link a}'? Auch ich muss @ChristianHackl zustimmen - das wäre eher verwirrend. Selbst wenn beide Parameter vom selben Typ sind und demselben Zweck dienen (zum Beispiel: 'add (int x, int y)') sollten Sie zumindest ihre Reihenfolge benutzen, um diese zu unterscheiden. – rbaleksandar

Wenn Sie einen oder mehrere Parameter, die von der gleichen docstring beschrieben werden, können Sie sie als durch Kommata getrennte Liste angeben. In Ihrem Fall

/**\brief What it does 
* \param[in] a,b some common description 
*/ 
void fun(
    const int& a 
    const int& b 
    int* c 
)

Quelle

2017-02-11 20:28:17 Frelling

Doxygen - gleiche docstring für mehrere Methodenparameter

Antwort

Verwandte Themen