2017-02-23 1 views
0

Ich habe einige Funktionen, die in Doxygen beschrieben werden sollte, wo 80% der Beschreibung identisch ist. Ich kann sie über sie kopieren, aber manchmal ändert sich diese Beschreibung, und unterstützende Änderungen in all diesen Funktionen werden Kopfschmerzen.Verwenden Sie den gleichen Text mehrmals in Doxygen

Gibt es einen Weg in Doxygen, um einen benannten Textblock zu erstellen, der nur einmal eingegeben wird und jede Funktion diesen benutzen kann?

So etwas:

//! /textblock <supername> that is the text that I would like to have just once, but that should appears in different places in documentation 
... 
//! my function 1. /useblock <supername>. Just as it is. 
void func1() { return; } 
... 
//! my function 2. /useblock <supername>. Yeah, make sense. 
void func2() { return; } 
... 
//! my function 3. /useblock <supername>. Such great it is. 
void func3() { return; } 
+0

Ich denke, der \ snippetdoc ist der Befehl, den Sie suchen. – albert

Antwort

0

ich den "alias" benutzerdefinierten Befehl in Doxygen für die Implementierung "Schnipsel" verwendet habe. Siehe https://www.stack.nl/~dimitri/doxygen/manual/custcmd.html. Obwohl die Erklärung es so aussehen lässt, wie Sie es nur für Funktionen verwenden können, ist es großartig für wiederholten Text.

Verwandte Themen