2012-02-01 17 views
19

ho aggiunto a un commento della classe:Doxygen @link a un URL non genera il link correttamente

@link http://www.google.com Google @endlink 

Tuttavia, quando ho generare la documentazione utilizzando doxygen, il testo del link è infatti "Google", ma il legame è quello di:

di file: ///media/portable/Examples/Doxygen/link/html/classClass1.html

qualcuno può spiegare cosa c'è di sbagliato?

risposta

29

Penso che si stia utilizzando \link in modo errato. Dal doxygen documentation, \link viene utilizzato per fare riferimento a oggetti come un file, una classe o un membro e prende come riferimento un argomento come primo argomento. Ad esempio, se volessi fare riferimento a un metodo di classe func nella classe myClass, vorrei utilizzare

\link myClass::func link text ... \endlink 

con tutti i restanti argomenti ritenuti di testo per un collegamento. Penso che il tuo problema sia che non passi un oggetto valido come primo argomento. Direi che classClass1 è l'oggetto successivo nel file in cui si è tentato di includere il collegamento e questo è il riferimento al comando \link.

Collegamento agli URL

Doxygen genererà collegamenti URL automaticamente, quindi non c'è alcuna necessità di circondare il legame con \link e \endlink o qualsiasi altri comandi. Quindi rimuovi quelli e vedi se questo risolve il problema.

specificare manualmente testo del link, utilizzare il codice HTML 'un' tag:

<a href="linkURL">link text</a> 

Per ulteriori informazioni su come doxygen gestisce collegamento automatico see this pagina di documentazione.

+0

Vedo, grazie Chris! –