come collegamento alla documentazione della directory

Question

Ho aggiunto un commento \dir per fornire una documentazione aggiuntiva alla directory. Ma non sono in grado di collegarmi a quella documentazione di directory usando una qualsiasi delle tecniche di collegamento Doxygen che conosco. La mia domanda è: come faccio a collegarmi correttamente alla documentazione di una directory?

Di seguito è riportato uno snippet di ciò che ho provato. Ricevo due avvisi e nessun collegamento generato. La sezione Collegamento automatico del manuale doxygen discute di Links to other members, ma non menziona i collegamenti a dirs. È supportato il collegamento alla documentazione della directory? Se è così, sto facendo qualcosa di sbagliato o si tratta di un bug? (Sto usando 1.8.10 in questo momento 1.8.9.1 si è comportato allo stesso modo.)

Ecco cosa ho provato. Ho documentato la directory utilizzando

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

E io riferimento alla directory utilizzando

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

Ecco le avvertenze:

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

La documentazione viene utilizzato per la directory, ma non ci fa sembra essere un modo per farvi riferimento. Apprezzo sinceramente qualsiasi aiuto.

Answer 1

Il modo corretto per collegarsi alla pagina di documentazione per una directory è utilizzare il comando \ref. I collegamenti espliciti che utilizzano # non sono supportati per le directory.

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

Questo esempio genererà un link alla documentazione della cartella cpp/vtutil. Tuttavia, è necessario prestare attenzione quando si utilizzano percorsi assoluti e l'impostazione di configurazione doxygen con STRIP_FROM_PATH. Quando eseguo doxygen con la directory di lavoro nell'albero dei sorgenti, posso ottenere il riferimento corretto del collegamento. Ma quando corro da una directory di compilazione, che è diversa dalla mia directory di origine, e ho bisogno di usare STRIP_FROM_PATH, allora ho dei problemi.

Doxygen è piuttosto permissivo o flessibile con il percorso utilizzato quando si documenta una directory con il comando \dir, ma è piuttosto schizzinoso quando fa riferimento al comando \ref.