Uso del comando \ link de doxygen

Question

Tengo un archivo HTML externo que me gustaría tener vinculado desde mi pestaña doxygen "Páginas relacionadas" o el marco de la izquierda. Parece que necesito usar el comando \link pero no puedo encontrar un buen ejemplo de cómo usarlo o dónde. Actualmente estoy usando doxywizard para generar el HTML.

Entonces, ¿es \link algo que incorporo a mi archivo de configuración doxygen o lo agrego cuando construyo el HTML de alguna manera?

actualización

así que terminé tener que hacer lo siguiente:

1. crear una nueva página (docs_main.html) que tenía los siguientes:

   /*! \mainpage MY TITLE HERE 
   * \section intro_sec External resources 
   * <a href="link_to_my_external_page.html">My external page</a> 
   */ 
   

2. Incluya esa página en mi lista de archivos incluidos en doxygen

3. reconstruir mi documentación

que sumado a mi doxygen "Página Principal" el siguiente

MY TITLE HERE 

My external page (which was a link to that page) 

Answer 1

Doxygen le permite insertar certain HTML commands en su documentación, incluidos los enlaces. En caso de que no sabe que esto es la forma de hacer un enlace en HTML:

<a href="externalfile.html">External file</a> 

cdiggins' answer es también vale la pena leer.

Answer 2

El \ enlace (y nada del comando de la forma \ o @Command) se llama un "especial comando "y es parte del marcado utilizado en los archivos de entrada procesados ​​por Doxygen que no forman parte de la configuración. El \link command no hace lo que quiere.

Quizás pueda usar el \page command para crear una nueva página relacionada y luego usar el \htmlinclude command para insertar el archivo HTML externo como el contenido de esa página.

Answer 3

Tenemos Markdown support en doxygen hoy en día. Su código puede ser una más clara:

/*! \mainpage MY TITLE HERE 
* \anchor intro_sec 
* # External resources 
* [My external page](http://link_to_my_external_page.html) 
*/ 

Lo anterior debería hacer algo cerca de:

---

recursos externos

My external page

---

Answer 4

Usted puede añadir una pestaña a la barra de navegación principal (con su enlace) utilizando un archivo de diseño personalizado.

Eche un vistazo a la página Customizing the Output del manual de Doxygen. Está bastante claro cómo hacerlo, suponiendo que entendí tu pregunta.

Answer 5

Como otras respuestas aquí parecen partes para un principiante, aquí está el procedimiento completo.

1) crear un archivo HTML con el contenido (por ejemplo: abc.html) como a continuación

/*! \mainpage MY TITLE HERE 
* \section intro_sec External resources 
* <a href="link_to_my_external_page.html">My external page</a> 
*/ 

2) Añadir esta ruta de archivo en el archivo de configuración aquí INPUT =

3) También añada su archivo escriba aquí FILE_PATTERNS =

El procedimiento anterior se abre el archivo en la ventana doxygen

Añadir el contenido de abajo para abrir el archivo en el Explorador de

<a href="link_to_my_external_page.html" target="_blank"><b>My external page</b></a>

Nota: Si el archivo no se abre trate de darle ruta absoluta