Wie soll ich ein Funktionsobjekt (AKA funktor) mit doxygen dokumentieren? Es fühlt sich irreführend an, es nur als reguläre Klasse zu dokumentieren. Ich finde es viel besser, ein Funktionsobjekt als eine Funktion mit einer Schließung zu betrachten als eine aufrufbare Klasse.
Gibt es eine Möglichkeit, ein Funktionsobjekt zu dokumentieren, das zu meinen Einstellungen passt?
%Vor% Geben Sie die Klassendokumentation an, setzen Sie das Wort funktor im ersten Satz (vorzugsweise als erstes Wort) und überspringen Sie die operator() -Dokumentation, wenn die Bedeutung offensichtlich ist.
Wohlgemerkt: Die Bedeutung ist oft nicht offensichtlich, wenn operator() überladen ist.
Sie können Doxygen Mitgliedergruppen verwenden, um alle Ihre Funktoren zusammen zu gruppieren. Vielleicht würde so etwas funktionieren:
%Vor%Tags und Links c++ doxygen function-object functor