Wie Sie mit der Dokumentation des Verzeichnisses

Question

verknüpfen Ich habe einen \dir Kommentar hinzugefügt, um einem Verzeichnis zusätzliche Dokumentation zu geben. Aber ich bin nicht in der Lage, mit dieser Verzeichnisdokumentation eine der Doxygen-Verknüpfungstechniken zu verknüpfen, die ich kenne. Meine Frage ist: Wie verlinke ich richtig auf die Dokumentation eines Verzeichnisses?

Unten ist ein Ausschnitt von dem, was ich versucht habe. Ich bekomme zwei Warnungen und keine generierten Links. Der Abschnitt Automatische Verknüpfung des doxygen-Handbuchs behandelt Links to other members, erwähnt jedoch keine Links zu Verzeichnissen. Wird eine Verknüpfung zur Verzeichnisdokumentation unterstützt? Wenn ja, mache ich etwas falsch oder ist das ein Fehler? (Ich verwende 1.8.10 gerade. 1.8.9.1 benahm sich auf die gleiche Weise.)

Hier ist, was ich versucht habe. Ich dokumentiert das Verzeichnis

/// \dir cpp/vtutil 
///  
/// \brief Brief description of the dir cpp/vtutil goes here 
/// 
/// \details A more detailed description goes here. 
///   

mit Und ich verweisen das Verzeichnis verwenden, sind

/// \file 
/// \brief Implements the vt application class. 
/// 
/// This file is in the \ref cpp/vtutil directory. 
/// What about #cpp/vtutil 

Hier werden die Warnungen:

warning : unable to resolve reference to `cpp/vtutil' for \ref command 
warning : explicit link request to 'cpp' could not be resolved 

Die Dokumentation für das Verzeichnis verwendet wird, aber es tut nicht scheinen eine Möglichkeit zu sein, darauf Bezug zu nehmen. Ich schätze jede Hilfe sehr.

Answer 1

Die korrekte Methode zum Verknüpfen der Dokumentationsseite für ein Verzeichnis besteht darin, den Befehl \ref zu verwenden. Explizite Links mit # werden für Verzeichnisse nicht unterstützt.

/// \file 
/// \brief Implements the vt application class. 
/// 
/// This file is in the \ref cpp/vtutil directory. 

Dieses Beispiel wird ein Link auf die Dokumentation des cpp/vtutil Ordner erzeugen. Bei der Verwendung absoluter Pfade und der Konfiguration der doxygen-Konfiguration mit STRIP_FROM_PATH ist jedoch Vorsicht geboten. Wenn ich doxygen mit dem Arbeitsverzeichnis in der Quellstruktur ausführe, kann ich die richtige Verweisverknüpfung abrufen. Aber wenn ich von einem Build-Verzeichnis laufe, das sich von meinem Quellverzeichnis unterscheidet, und STRIP_FROM_PATH verwenden muss, dann habe ich Probleme.

Doxygen ist ziemlich fehlerverzeihend oder flexibel mit dem Pfad, der beim Dokumentieren eines Verzeichnisses mit dem Befehl verwendet wird, aber es ist ziemlich wählerisch, wenn es mit dem Befehl \ref referenziert wird.