Existen varios comandos doxygen cuyo propósito es crear enlaces en la documentación (@link, @ref).
Actualmente estoy usando el comando @ref para crear un enlace a un archivo personalizado, escrito en un idioma no admitido por doxygen (xml).
Me gustaría modificar este enlace para que apunte a una línea precisa en el archivo.
¿Hay un comando doxygen que permita hacer eso?En la documentación doxygen cómo crear un enlace a una línea específica de un archivo
7
A
Respuesta
6
No estoy seguro de que \ref
o \link
puedan hacer esto. Sin embargo, si pudieran, un problema de adoptar este enfoque es que los enlaces se volverán inválidos si cambia el contenido del archivo al que está vinculando sin cambiar el enlace. Este es uno de los problemas de separar el código fuente y la documentación.
En lugar de vincular a una línea particular en otro archivo, ¿por qué no incluye la parte específica del archivo que le interesa en la documentación? Usted podría:
- incluyen todo el archivo con
\include
(también hay\includelineno
) y acaba de Referencia partes pertinentes de la misma en el texto (por ejemplo, "la función xxx en el código de abajo"), o - incluye fragmentos del archivo donde necesita referirse a ellos en la documentación usando
\snippet
.
Editar: Como alternativa, puede utilizar el comando \dontinclude
que, junto con los \line
, \skip
, \skipline
y \until
comandos le permite incluir líneas/bloques de un archivo en particular específicos. Vea el ejemplo en la documentación \dontinclude
.
Cuestiones relacionadas
- 1. Doxygen documentación C++ plantilla en línea
- 2. Enlace web en la documentación
- 3. Crear un enlace a un archivo descargable en Orchard CMS
- 4. Cómo crear un enlace a un directorio
- 5. Doxygen y agregue un valor de un atributo a la documentación de salida
- 6. Alcanzar una línea específica en un archivo usando RandomAccessFile
- 7. Lectura de una línea específica de un archivo
- 8. Documentación para comentarios sobre la documentación de Qt? Qt + Doxygen?
- 9. Doxygen @ link a una URL no genera el enlace correctamente
- 10. Documentación "interna" separada de "externa" en doxygen
- 11. ¿Cómo puedo reemplazar una línea específica por número de línea en un archivo de texto?
- 12. Cómo hacer un enlace a la línea de archivo externo en Emacs org-mode
- 13. Crear un enlace a un archivo en la ubicación de red en la confluencia
- 14. ¿Cómo incluir la carpeta en la documentación de doxygen?
- 15. Doxygen: Agregar un enlace personalizado en la sección "Páginas relacionadas"
- 16. Documentación de estructuración al utilizar Doxygen
- 17. ¿Cómo abrir un archivo en Eclipse Y saltar a una línea específica?
- 18. ¿Cómo puedo poner un enlace intersphinx a un método arbitrario en la documentación de la biblioteca estándar?
- 19. Extender un segmento de línea a una distancia específica
- 20. variables de Documentación con Doxygen en C
- 21. Leyendo línea específica de un archivo en PHP
- 22. cómo escribir contenido en una posición específica en un archivo
- 23. URL para un enlace a Twitter por un tweet específica
- 24. ¿Borrar línea específica de un archivo de texto?
- 25. Documentación de funciones de macros en C++ con Doxygen
- 26. Generar documentación de código HTML de un solo archivo
- 27. ¿Cómo crear un enlace simbólico con SCons?
- 28. Rutas de archivos relativos en la documentación generada por doxygen
- 29. ¿Cómo crear un enlace descargable al archivo de texto?
- 30. archivo de reglas de Debian crear un enlace simbólico
Gracias por sus sugerencias. El comando '\ snippet' parecía prometedor, sin embargo, solo funciona para los fragmentos de código de _source files_, mientras que yo quiero mostrar datos de mi _xml resource file_. No puedo agregar las etiquetas que identifican la ubicación del fragmento a mi archivo xml porque los comentarios estilo doxygen lo "romperían". El uso de \ include también es inteligente, pero es un archivo enorme y no quiero incluirlo cada vez (la documentación se borrará con datos irrelevantes). Sin embargo, cuando uso \ ref para mi archivo, ya hago referencia a partes relevantes, como sugiere. Solo estoy buscando una forma aún mejor. – wil
@wil No hay problema. También agregué una nota sobre el comando '\ dontinclude', que sería mejor para usted que el comando' \ snippet' ya que no requiere que se agregue ninguna etiqueta a su archivo de recursos. Sin embargo, de acuerdo con la documentación, parece que este comando solo funciona en los archivos fuente (no lo he probado, así que no estoy seguro si este es realmente el caso). También podría incluir el XML directamente en su documentación. En su defecto, me temo que es posible que deba vivir usando su método '\ ref'. – Chris
¡Probé los comandos '\ dontinclude' y también funciona para archivos xml! Me he conformado con esta solución y configuré su respuesta como "aceptada" :-) – wil