Nella documentazione doxygen come creare un collegamento a una riga specifica di un file

Question

Esistono diversi comandi doxygen che hanno lo scopo di creare collegamenti nella documentazione (@link, @ref).
Attualmente sto utilizzando il comando @ref per creare un collegamento a un file personalizzato, scritto in una lingua non supportata da doxygen (xml).
Vorrei modificare questo collegamento in modo che punti a una riga precisa nel file.
Esiste un comando doxygen che consente di farlo?

Answer 1

Non sono sicuro che \ref o \link possa farlo. Tuttavia, se potessero, un problema nell'adottare questo approccio è che i collegamenti non saranno più validi se si modifica il contenuto del file a cui si sta collegando senza modificare il collegamento. Questo è uno dei problemi di separazione tra codice sorgente e documentazione.

Piuttosto che collegarsi a una particolare linea in un altro file, perché non includi la parte specifica del file che ti interessa nella documentazione? Si potrebbe o:

• comprendono l'intero file con \include (c'è anche \includelineno) e appena riferimento parti rilevanti di esso nel testo (ad esempio "la funzione xxx nel seguente codice"), o
• includono frammenti del file in cui è necessario fare riferimento ad essi nella documentazione utilizzando \snippet.

Edit: In alternativa, è possibile utilizzare il comando \dontinclude che, insieme con i \line, \skip, \skipline, e \until comandi consente di includere le linee/blocchi di un particolare file specifici. Vedere l'esempio nella documentazione \dontinclude.