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?Nella documentazione doxygen come creare un collegamento a una riga specifica di un file
risposta
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
.
- 1. Come includere la cartella nella documentazione doxygen?
- 2. Come creare un collegamento a una directory
- 3. In Python sfinge, come creare un collegamento a un file nella directory _static
- 4. doxygen + sfinge (respirare) per documentazione
- 5. Genera documentazione JavaScript con Doxygen
- 6. Come eliminare una riga specifica da un file in unix?
- 7. Lettura di una riga specifica di un file
- 8. Documentazione di un membro non esistente con Doxygen
- 9. PhoneGap: Creare un file in una cartella specifica
- 10. Creare un collegamento HTML a un file in un'altra porta?
- 11. Come posso mantenere doxygen dalla documentazione di #defines in un file C?
- 12. Collegamento di Windows a un collegamento simbolico a un eseguibile
- 13. Genera documentazione come file di markdown usando doxygen
- 14. Come creare un collegamento ipertestuale a un foglio Excel diverso nella stessa cartella di lavoro
- 15. Ovunque mostra tutte le funzioni libere nella documentazione doxygen?
- 16. come collegamento alla documentazione della directory
- 17. Come creare un file di documentazione R (.Rd) in lattice?
- 18. YARD: come creare un collegamento a un metodo di classe?
- 19. Misurazione della copertura della documentazione con Doxygen
- 20. Collegamento a un file statico di Hamlet
- 21. Collegamento a scheda specifica Bootstrap
- 22. La documentazione non viene visualizzata nell'output doxygen
- 23. Doxygen e aggiunta di un valore di un attributo alla documentazione di output
- 24. Previene l'overflow della riga nella documentazione R?
- 25. Separato "interno" dalla documentazione "esterna" in doxygen
- 26. Creare un collegamento ipertestuale all'interno di una cella di Excel?
- 27. Come faccio a creare di Visual Studio file di collegamento
- 28. Elimina la riga specifica da un file di testo?
- 29. Come si crea un collegamento ipertestuale da una cella specifica a Word, senza macro/vba?
- 30. Come creare un collegamento a livello di codice utilizzando Win32
Grazie per i vostri suggerimenti. Il comando '\ snippet' sembrava promettente, tuttavia funziona solo per frammenti di codice da _source files_, mentre voglio mostrare i dati dal mio _xml resource file_. Non riesco ad aggiungere i tag che identificano la posizione snippet al mio file xml perché i commenti in stile "ossigeno" lo "spezzano". Anche l'uso di \ include è intelligente, ma è un file enorme e non voglio includerlo ogni volta (la documentazione verrebbe cancellata da dati irrilevanti). Tuttavia, quando uso un \ ref al mio file, faccio già riferimento a parti rilevanti, come suggerisci tu. Sto solo cercando un modo ancora migliore. – wil
@wil Nessun problema. Ho anche aggiunto una nota sul comando '\ dontinclude', che sarebbe meglio per voi rispetto al comando' \ snippet' poiché non richiede l'aggiunta di alcun tag al file di risorse. Tuttavia, secondo la documentazione, sembra che questo comando funzioni solo sui file sorgente (non l'ho testato, quindi non sono sicuro che sia effettivamente così). È anche possibile includere l'XML direttamente nella documentazione. In caso contrario, temo che potresti dover semplicemente convivere con il tuo metodo '\ ref'. – Chris
Ho provato i comandi '\ dontinclude' e funziona anche per i file xml! Mi sono accontentato di questa soluzione e ho impostato la tua risposta come "accettata" :-) – wil