Ein Beispiel aus mehreren Quelldateien in Doxygen

Ich dokumentiere eine Gruppe von Klassen, die zusammenarbeiten, mit Doxygen und ich schrieb ein Beispiel über mehrere Quelldateien verteilt (Alle referenziert von EXAMPLE_PATH). Genauer gesagt, schrieb ich folgendes:Ein Beispiel aus mehreren Quelldateien in Doxygen

/*************************************//** 
* Some context... 
* @example Source1.cpp 
* 
* More context... 
* @example Source2.cpp 
****************************************/

Das Problem ist, dass die Ausgabe in die Hälfte in der Beispielseite von Doxygen (eine Seite für Source1, eine andere für Source2) erzeugt verbreitet wird. Ich möchte es alle auf der gleichen HTML-Seite sein, mit dem Kontext und Beispielcode zusammen als ein Tutorial:

Some context... 
|----------------------------------------------| 
| int main()         | 
| {           | 
| //...          | 
| }           | 
|----------------------------------------------| 

More context... 
|----------------------------------------------| 
| bool fct()         | 
| {           | 
| //...          | 
| }           | 
|----------------------------------------------|

Gibt es eine Möglichkeit, dies zu erreichen? Ich benutze Doxygen 1.8.11.

Grüße

Quelle

2017-09-07 BobMorane

Kann ein bisschen detailliertere Informationen geben. z.B. klein Source1.cpp und Source2.cpp (nur 1 oder 2 Zeilen in den Dateien sind ausreichend), die aktuelle Ausgabe und die Ausgabe, die Sie haben möchten? Welche Version von doxygen verwenden Sie? – albert

@albert gerade aktualisiert. Hilft das? – BobMorane

Ich habe es jetzt (glaube ich), die Beispiele sind auf separaten Seiten dargestellt. Haben Sie sich mal \ verbinclude und \ include angesehen, könnte auch \ snippet einige Möglichkeiten bieten? – albert

ich eine semi-Legit Lösung gefunden: Wenn Sie den @example-Tag am Anfang hinzufügen und @include s verwenden danach, es funktioniert:

/*************************************//** 
* @example "My tutorial" 
* 
* Some context... 
* @include Source1.cpp 
* 
* More context... 
* @include Source2.cpp 
****************************************/

jedoch bei der Fehlerausgabe der Suche aus Doxygen bekomme ich die folgende Meldung: warning: included file My is not found. Check your EXAMPLE_PATH

Die Lösung ist nicht sauber, aber vorläufig benutzbar. Wenn Sie einen besseren Vorschlag (d. H. Warnung entfernt) haben, teilen Sie es bitte und ich werde es akzeptieren.

Quelle

2017-09-07 20:05:53 BobMorane

Entgegen der Dokumentation sieht es aus, wenn Sie den Dateinamen weglassen, dass es keine Warnung ausgibt. Was tatsächlich requited ist, ist so etwas wie dieses Beispiel "Header". – albert

@albert Ich habe es versucht und es scheint, dass, wenn Sie den Dateinamen weglassen, nimmt Doxygen an, dass der Dateiname der aktuelle Dateiname ist (wo der obige Code liegt). Wenn Sie Code in dieser Datei haben, der nicht verwandt ist, wird es enthalten sein. – BobMorane

Ein Beispiel aus mehreren Quelldateien in Doxygen

Antwort

Verwandte Themen