2012-02-01 18 views
19

He añadido a un comentario de la clase:Doxygen @ link a una URL no genera el enlace correctamente

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

Sin embargo, cuando genero documentación mediante Doxygen, el texto del enlace es de hecho "Google", pero el enlace es:

archivo

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

puede alguien explicar lo que está mal?

Respuesta

29

Creo que está utilizando \link incorrectamente. Desde el doxygen documentation, \link se usa para referirse a objetos como un archivo, clase o miembro y toma como referencia uno de estos como primer argumento. Por ejemplo, si quisiera hacer referencia a un método de clase func en la clase myClass, me gustaría utilizar

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

con todos los argumentos restantes consideradas como texto para un enlace. Creo que su problema es que no pasa un objeto válido como primer argumento. Supongo que classClass1 es el siguiente objeto en el archivo donde intentó incluir el enlace y esto es lo que hace referencia al comando \link.

Vinculación de direcciones URL a

Doxygen generará enlaces URL de forma automática, por lo que no hay necesidad de rodear el enlace con \link y \endlink o cualquier otro comando. Entonces quítelos y vea si eso soluciona el problema.

Para especificar manualmente el texto del vínculo, utilice el código HTML 'a' de la etiqueta:

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

Para obtener más información acerca de cómo maneja doxygen automática que une see this página de documentación.

+0

Ya veo, gracias Chris! –

Cuestiones relacionadas