[Doxygen] mehrfach verwendete Dokumentation
-
Ich hab' hier ein kleines Problem mit der Code-Dokumentation eines kommutativen Operators:
Ich habe einen
operator*(double,const MyType&)undoperator*(const MyType&,double), die abgesehen von der Operanden-Reihenfolge identisch sind. Also wollte ich auch für beide Operatoren eine gemeinsame Dokumentation anlegen. In der Theorie klingt das auch recht einfach:/** Skalierung (links). Hier folgt eine längere Erklärung des Operators. ... */ myType operator*(double fakt,const myType& base); /** Skalierung (rechts). @copydoc operator*() */ myType operator*(const myType& base,double fakt);Das einzige Problem dabei ist: Doxygen mag diese Konstruktion nicht und gibt mir eine Warnmeldung:
Warning: target operator*() of \copydoc command not found
Wie kann ich ihm klarmachen, daß ich die direkt darüber stehende Dokumentaion des Operators verlinkt haben will? (ich hab' auch schon die Parameterlisten
operator*(double,myType)oderoperator*(double,const myType&)angegeben - mit dem selben Ergebnis)PS: Ein anderes ähnliches Problem: Gibt es eine Möglichkeit, nur Teile der Dokumentation wiederzuverwerten?
-
http://www.stack.nl/~dimitri/doxygen/commands.html#cmdcopydoc
Hab nicht viel Erfahrung mit doxygen, aber evtl. hilft die offizielle Doku

-
phlox81 schrieb:
Hab nicht viel Erfahrung mit doxygen, aber evtl. hilft die offizielle Doku

Nicht wirklich - die Doku habe ich hier auch vorliegen. (Anmerkung: Bei einer normalen überladenenen Funktion hat \copydoc problemlos mitgearbeitet)
-
habe gerade das gleiche Problem,
Es liegt wohl daran, dass operator in doxygen ein schlüsselwort ist,
ein weiteres problem was mir dabei aufgefallen ist, dass sachen wie
/**
<b> operator </b>
*/in der doku dann so aussehen:
operator</b>
weitere textdort hilft es dann z.B. Operator groß zu schreiben.
Was ich jetzt abe noch suche, ist eine möglichkeit doxygen zu sagen, dass er das operator nicht als schlüsselwort ansehen soll, also etwas wie
@copydoc 'operator'*() (was so natürlich nicht funktioniert)